get https://your-url-here.com/BillingInfoAPI/policy/
Returns billing summary for a given account
Body Response - Schema
200 OK
policy_billing_details_reponse:
type: object
properties:
billing_address:
type: string
billing_method:
type: string
charges_details:
type: array
items:
type: object
$ref: '#/definitions/policy_ChargeDetails'
delinquencies:
type: integer
delinquencies_details:
type: array
items:
type: object
$ref: '#/definitions/policy_DelinquencyDetails'
invoices_details:
type: array
items:
type: object
$ref: '#/definitions/policy_InvoiceDetails'
next_invoice_due:
type: string
next_invoice_due_amount:
type: string
payment_instrument:
type: string
payment_plan:
type: string
payor:
type: string
policy_number:
type: string
send_invoices_by:
type: string
total_currently_billed:
type: string
total_outstanding:
type: string
total_paid:
type: string
total_past_due:
type: string
total_unbilled:
type: string
definitions:
policy_ChargeDetails:
type: object
properties:
charge_amount:
type: string
charge_date:
type: string
charge_type:
type: string
policy_DelinquencyDetails:
type: object
properties:
delinquency_reason:
type: string
delinquency_target:
type: string
delinquent_amount:
type: string
grace_period_end_date:
type: string
start_date:
type: string
status:
type: string
policy_InvoiceDetails:
type: object
properties:
amount:
type: string
due_amount:
type: string
invoice_bill_date:
type: string
invoice_due_date:
type: string
invoice_items_details:
type: array
items:
type: object
$ref: '#/definitions/policy_InvoiceItemDetails'
invoice_number:
type: string
status:
type: string
policy_InvoiceItemDetails:
type: object
properties:
amount:
type: string
category:
type: string
description:
type: string
installment_number:
type: integer
paid_amount:
type: string
product:
type: string
400's
ErrorInfo:
type: object
properties:
details:
type: array
items:
type: object
$ref: '#/definitions/ErrorDetails'
developerMessage:
type: string
errorCode:
type: string
status:
type: integer
userMessage:
type: string
definitions:
ErrorDetails:
type: object
properties:
message:
type: string
properties:
type: object
$ref: '#/definitions/ErrorDetailsProperties'
stackTrace:
type: string
ErrorDetailsProperties:
type: object
properties:
lineNumber:
type: integer
parameterLocation:
type: string
parameterName:
type: string
API Availability
The Financial Services Experience Cloud for Insurance - Integrations Bridge is only available for customers enrolled in Talkdesk's Early Access (EA) program. To enter the EA program, contact a Customer Success Manager.
The Financial Services Experience Cloud for Insurance - Integrations Bridge has been in EA since November 2023.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.