Nightly Jobs Module API
API reference for nightly job endpoints.
BriteCore v2 Nightly Jobs API endpoint wrappers.
This module provides wrappers for invoking BriteCore nightly processing jobs such as autopays, renewals, cancellations, and non-pay workflows.
- britecore_sdk.api.api_calls.v2.nightly_jobs.process_auto_pays(on_date=None, policy_number=None, **kwargs)[source]
Process automatic payments for a date or policy.
- Parameters:
on_date (str | None)
policy_number (str | None)
kwargs (Unpack[RequestParameters])
- Return type:
Any
- britecore_sdk.api.api_calls.v2.nightly_jobs.process_cancellation_pending_or_non_renewals(on_date=None, policy_number=None, **kwargs)[source]
Process cancellation-pending or non-renewal policies.
- Parameters:
on_date (str | None)
policy_number (str | None)
kwargs (Unpack[RequestParameters])
- Return type:
Any
- britecore_sdk.api.api_calls.v2.nightly_jobs.process_non_pays_and_cancellations(on_date=None, policy_number=None, **kwargs)[source]
Process non-pay and cancellation events.
- Parameters:
on_date (str | None)
policy_number (str | None)
kwargs (Unpack[RequestParameters])
- Return type:
Any
- britecore_sdk.api.api_calls.v2.nightly_jobs.process_renewals(policy_number=None, renew_date=None, **kwargs)[source]
Process policy renewals for a renewal date or policy.
- Parameters:
policy_number (str | None)
renew_date (str | None)
kwargs (Unpack[RequestParameters])
- Return type:
Any