Skip to main content

BillToContactSchema

_employernullable
_employer_idintegernullable
_sales_entitynullable
_sales_entity_idintegernullable
aggregate_emails_by_contactbooleannullable
all_bank_accountsundefined[]
bank_accountsundefined[]
bill_to_typenullable
billable_entity
billable_entity_id
billing_contact_methodnullable
contact_idintegerrequired
createdbynullable
createdby_idintegernullable
createddatedate-timenullable
disable_overduebooleannullable
hs_aggregate_emails_by_contactbooleannullable

Combine multiple invoices into a single email before sending

hs_disable_overduebooleannullable

Disable setting an invoice as overdue. Used when a tenant doesn't import invoice balances back into TPAStream.

hs_include_csv_detail_linkbooleannullable

Include a link to download the invoice details CSV in invoice email

hs_include_divisional_breakdownbooleannullable

Include divisional billing breakdown information on invoices and related communications

hs_include_pdf_detail_linkbooleannullable

Include a link to download the invoice details PDF in invoice email

hs_include_pdf_summary_attachmentbooleannullable

Attach the invoice summary PDF to invoice email

hs_include_portal_access_linkbooleannullable

Include a link to the remittance dashboard in invoice email

hs_invoice_day_of_month_dueintegernullable
hs_invoice_due_daysintegernullable
hs_invoice_email_templatenullable
hs_invoice_email_template_uuiduuidnullable
hs_invoice_footer_templatenullable
hs_invoice_footer_template_uuiduuidnullable
hs_invoice_header_templatenullable
hs_invoice_header_template_uuiduuidnullable
hs_invoice_redirect_url_templatestringnullable

Custom redirect URL template for the View Invoice CTA in invoice emails. Supports {invoice_id} and {invoice_key} tokens.

hs_require_mfa_for_portal_accessbooleannullable

Require MFA for portal access. This is used in conjunction with the portal_access setting.

hs_show_account_statusbooleannullable

Billing Setting to show the account status in the invoice line item breakout

hs_streamlined_employer_portalbooleannullable

Send this group to the new broker portal (but for employers)

hs_whitelabel_display_namestringnullable
hs_whitelabel_localstringnullable
hs_whitelabel_subdomainstringnullable
idinteger
include_csv_detail_linkboolean
include_divisional_breakdownbooleannullable
include_pdf_detail_linkboolean
include_pdf_summary_attachmentboolean
include_portal_access_linkboolean
invoice_day_of_month_dueintegernullable
invoice_due_daysstringnullable
invoice_email_template_uuidstring
invoice_footer_template_uuidstring
invoice_header_template_uuidstring
invoice_redirect_url_templatestringnullable
labelstringrequired
modifiedbynullable
modifiedby_idintegernullable
modifieddatedate-timenullable
require_mfa_for_portal_accessbooleannullable
restrict_download_import
show_account_statusbooleannullable
streamlined_employer_portalbooleannullable
tenant_idintegerrequired
vendor_bill_to_contactsundefined[]
whitelabel_display_namestringnullable
whitelabel_email_addressstring
whitelabel_from_addressstringnullable
whitelabel_localstringnullable
whitelabel_subdomainstringnullable
BillToContactSchema
{
  "_employer_id": 0,
  "_sales_entity_id": 0,
  "aggregate_emails_by_contact": true,
  "all_bank_accounts": [
    null
  ],
  "bank_accounts": [
    null
  ],
  "billable_entity": {},
  "contact_id": 0,
  "createdby_id": 0,
  "createddate": "2024-07-29T15:51:28.071Z",
  "disable_overdue": true,
  "hs_aggregate_emails_by_contact": true,
  "hs_disable_overdue": true,
  "hs_include_csv_detail_link": true,
  "hs_include_divisional_breakdown": true,
  "hs_include_pdf_detail_link": true,
  "hs_include_pdf_summary_attachment": true,
  "hs_include_portal_access_link": true,
  "hs_invoice_day_of_month_due": 0,
  "hs_invoice_due_days": 0,
  "hs_invoice_email_template_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hs_invoice_footer_template_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hs_invoice_header_template_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hs_invoice_redirect_url_template": "string",
  "hs_require_mfa_for_portal_access": true,
  "hs_show_account_status": true,
  "hs_streamlined_employer_portal": true,
  "hs_whitelabel_display_name": "string",
  "hs_whitelabel_local": "string",
  "hs_whitelabel_subdomain": "string",
  "id": 0,
  "include_csv_detail_link": true,
  "include_divisional_breakdown": true,
  "include_pdf_detail_link": true,
  "include_pdf_summary_attachment": true,
  "include_portal_access_link": true,
  "invoice_day_of_month_due": 0,
  "invoice_due_days": "string",
  "invoice_email_template_uuid": "string",
  "invoice_footer_template_uuid": "string",
  "invoice_header_template_uuid": "string",
  "invoice_redirect_url_template": "string",
  "label": "string",
  "modifiedby_id": 0,
  "modifieddate": "2024-07-29T15:51:28.071Z",
  "require_mfa_for_portal_access": true,
  "show_account_status": true,
  "streamlined_employer_portal": true,
  "tenant_id": 0,
  "vendor_bill_to_contacts": [
    null
  ],
  "whitelabel_display_name": "string",
  "whitelabel_email_address": "string",
  "whitelabel_from_address": "string",
  "whitelabel_local": "string",
  "whitelabel_subdomain": "string"
}