API Reference

Start a Billing Job

post
https://api.bridgeft.com/v2/billing/reports

Starts a Billing Job with PDF Reporting and returns the created Background Job Instance

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Number of items to return per page

integer

Current page number

Body Params
int64
required

Unique ID for the object

string

The date to run a billing calculation on

boolean

Whether to create Invoice PDFs during the billing calculation job

boolean
required

When this option is true, invoices will be created at the household level. Each household in the billing run will receive an invoice with billing details included for each individual account in that respective household. If accounts in the billing run do not belong to a household, each individual account will receive their own invoice. When this option is false, invoices will be generated for each billing group containing billing details for each account in the respective billing group.

boolean

If true, this sends an email notification to the user who created the job

string
enum
required

Whether to create an invoice using the standard (S) or exact (E) billing period

Allowed:
group_ids
array of integers | null

An array of billing group ids

group_ids
settings_overrides
object | null

settings_overrides provides the ability to override default billing and invoice settings that are set by default in the Firm resource.

Responses

Updated 8 months ago

Language
Credentials
Bearer
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 months ago