--- updatedAt: 2026-05-07T11:46:38.000Z agentTools: projectIndex: https://docs.talkdesk.com/llms.txt --- # Get guarantor billing summary Returns the billing summary for a guarantor, including balance details, aging summaries, payment plan information, and associated patient records. At least one of `patient_id` or `self_service_id` must be provided. ## Scope `hls-guarantor-billing:read` # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "Public API", "version": "5.12.71", "description": "Documents public API endpoints. Scopes are given to external software, that we don't control", "contact": { "name": "Talkdesk", "url": "https://talkdesk.com" } }, "servers": [ { "url": "https://api.talkdeskapp.com", "description": "United States (td-us-1)" }, { "url": "https://api.talkdeskapp.eu", "description": "Europe (td-eu-1)" }, { "url": "https://api.talkdeskappca.com", "description": "Canada (td-ca-1)" }, { "url": "https://api.talkdeskapp.co.uk", "description": "United Kingdom (td-uk-1)" } ], "tags": [ { "name": "HLS Providers" } ], "paths": { "/healthcare/guarantors/{guarantor_id}/billing": { "get": { "tags": [ "HLS Providers" ], "summary": "Get guarantor billing summary", "description": "Returns the billing summary for a guarantor, including balance details, aging summaries, payment plan information, and associated patient records. At least one of `patient_id` or `self_service_id` must be provided.", "operationId": "getGuarantorBillingSummary", "security": [ { "GA": [ "hls-guarantor-billing:read" ] } ], "parameters": [ { "name": "guarantor_id", "in": "path", "required": true, "description": "Unique identifier of the guarantor whose billing summary is being retrieved.", "schema": { "type": "string", "minLength": 1, "example": "2552" } }, { "name": "patient_id", "in": "query", "required": false, "description": "Patient identifier. At least one of `patient_id` or `self_service_id` must be provided.", "schema": { "type": "string", "minLength": 1, "example": "enh2Q1c0oNRtWzXZrnG4tKw3" } }, { "name": "self_service_id", "in": "query", "required": false, "description": "Self-service identifier. At least one of `patient_id` or `self_service_id` must be provided.", "schema": { "type": "string", "minLength": 1, "example": "SSI123456" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Billing summary for a guarantor account.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the guarantor.", "example": "2552" }, "account_ids": { "type": "array", "description": "List of EHR identifiers for the guarantor account.", "items": { "type": "object", "description": "An identifier with a type label.", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Identifier value.", "example": "E100001" }, "type": { "type": "string", "description": "Identifier type (e.g., EPI, MRN, CSN).", "example": "EPI" } } } }, "account_type": { "description": "The type of the guarantor account.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "billing_system": { "type": "string", "description": "The billing system used for this account.", "example": "Epic" }, "credit_score": { "type": "string", "description": "Credit score associated with the guarantor account.", "example": "750" }, "is_confidential_guarantor": { "type": "boolean", "description": "Whether the guarantor is marked as confidential." }, "is_paperless": { "type": "boolean", "description": "Whether the guarantor is enrolled in paperless billing." }, "owning_deployment_descriptor": { "type": "string", "description": "Epic deployment descriptor that owns this account.", "example": "MAIN" }, "patient_is_guarantor": { "type": "boolean", "description": "Whether the patient is also the guarantor." }, "patients": { "type": "array", "description": "List of patients associated with this guarantor account.", "items": { "type": "object", "description": "A patient associated with a guarantor billing account.", "properties": { "date_of_birth": { "type": "string", "format": "date", "description": "Date of birth of the patient (yyyy-MM-dd).", "example": "1980-04-15" }, "legal_name": { "type": "string", "description": "Legal name of the patient (Last, First format).", "example": "Doe, John" }, "preferred_name": { "type": "string", "description": "Preferred name of the patient.", "example": "John" }, "legal_sex": { "description": "Legal sex of the patient.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "gender_identity": { "type": "string", "description": "Gender identity of the patient.", "example": "Male" }, "ids": { "type": "array", "description": "List of EHR identifiers for the patient.", "items": { "type": "object", "description": "An identifier with a type label.", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Identifier value.", "example": "E100001" }, "type": { "type": "string", "description": "Identifier type (e.g., EPI, MRN, CSN).", "example": "EPI" } } } } } } }, "professional_billing": { "description": "Professional (physician) billing section.", "type": "object", "properties": { "aging_summaries": { "type": "array", "description": "List of aging bucket entries.", "items": { "type": "object", "description": "A single aging bucket entry.", "properties": { "amount": { "type": "number", "format": "double", "description": "Balance amount for this aging bucket." }, "display": { "type": "string", "description": "Human-readable label for the aging bucket.", "example": "0-30 days" } } } }, "balance_summary": { "description": "Summary of balances for this billing section.", "type": "object", "properties": { "amount_due": { "type": "number", "format": "double", "description": "Total amount currently due." }, "balance_not_on_payment_plan": { "type": "number", "format": "double", "description": "Balance not included in a payment plan." }, "balance_on_payment_plan": { "type": "number", "format": "double", "description": "Balance covered by an active payment plan." }, "charge_total": { "type": "number", "format": "double", "description": "Total charges." }, "insurance_balance": { "type": "number", "format": "double", "description": "Balance owed by insurance." }, "insurance_payment_adjustment_total": { "type": "number", "format": "double", "description": "Total insurance payment adjustments." }, "patient_balance": { "type": "number", "format": "double", "description": "Balance owed by the patient." }, "patient_payment_adjustment_total": { "type": "number", "format": "double", "description": "Total patient payment adjustments." }, "total_balance": { "type": "number", "format": "double", "description": "Combined patient and insurance balance." } } }, "last_payment": { "description": "Details of the most recent payment.", "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Payment amount." }, "date": { "type": "string", "format": "date", "description": "Date the payment was made (yyyy-MM-dd).", "example": "2026-03-01" }, "description": { "type": "array", "description": "Description of the payment.", "example": [ "Patient payment" ], "items": { "type": "string" } }, "source": { "type": "string", "description": "Source of the payment (e.g., Patient, Insurance)." }, "code": { "type": "string", "description": "Payment code." }, "reference_number": { "type": "string", "description": "Reference number for the payment." } } }, "last_statement": { "description": "Details of the most recent billing statement.", "type": "object", "properties": { "balance": { "type": "number", "format": "double", "description": "Balance on the last statement." }, "date": { "type": "string", "format": "date", "description": "Date the statement was issued (yyyy-MM-dd).", "example": "2026-02-15" }, "type": { "description": "Type of the statement.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "view_status": { "type": "string", "description": "Indicates whether the statement has been viewed.", "example": "Viewed" } } }, "message": { "type": "string", "description": "Optional message associated with this billing section." }, "outstanding_account": { "description": "Outstanding account balance details. Populated for hospital billing and single billing office sections.", "type": "object", "properties": { "bad_debt_balance": { "type": "number", "format": "double", "description": "Balance in bad debt." }, "insurance_balance": { "type": "number", "format": "double", "description": "Balance owed by insurance." }, "last_self_pay_payment_date": { "type": "string", "format": "date", "description": "Date of the last self-pay payment (yyyy-MM-dd).", "example": "2026-03-15" }, "last_statement_date": { "type": "string", "format": "date", "description": "Date of the last statement (yyyy-MM-dd).", "example": "2026-02-28" }, "patient_balance": { "type": "number", "format": "double", "description": "Balance owed by the patient." }, "self_pay_followup_level": { "description": "Follow-up level for self-pay collections.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "total_balance": { "type": "number", "format": "double", "description": "Total outstanding balance." } } }, "payment_plan": { "description": "Active payment plan details, if any.", "type": "object", "properties": { "amount_due": { "type": "number", "format": "double", "description": "Current amount due under the payment plan." }, "monthly_amount_due": { "type": "number", "format": "double", "description": "Monthly payment amount." }, "next_due_date": { "type": "string", "format": "date", "description": "Date the next payment is due (yyyy-MM-dd).", "example": "2026-05-01" }, "number_of_payments_left": { "type": "string", "description": "Number of remaining payments.", "example": "6" }, "original_amount": { "type": "number", "format": "double", "description": "Original total amount of the payment plan." }, "remaining_amount": { "type": "number", "format": "double", "description": "Remaining balance of the payment plan." }, "start_date": { "type": "string", "format": "date", "description": "Date the payment plan started (yyyy-MM-dd).", "example": "2025-11-01" }, "is_late": { "type": "boolean", "description": "Whether the payment plan is past due." }, "overdue_amount": { "type": "number", "format": "double", "description": "Amount overdue on the payment plan." } } } } }, "hospital_billing": { "description": "Hospital billing section.", "type": "object", "properties": { "aging_summaries": { "type": "array", "description": "List of aging bucket entries.", "items": { "type": "object", "description": "A single aging bucket entry.", "properties": { "amount": { "type": "number", "format": "double", "description": "Balance amount for this aging bucket." }, "display": { "type": "string", "description": "Human-readable label for the aging bucket.", "example": "0-30 days" } } } }, "balance_summary": { "description": "Summary of balances for this billing section.", "type": "object", "properties": { "amount_due": { "type": "number", "format": "double", "description": "Total amount currently due." }, "balance_not_on_payment_plan": { "type": "number", "format": "double", "description": "Balance not included in a payment plan." }, "balance_on_payment_plan": { "type": "number", "format": "double", "description": "Balance covered by an active payment plan." }, "charge_total": { "type": "number", "format": "double", "description": "Total charges." }, "insurance_balance": { "type": "number", "format": "double", "description": "Balance owed by insurance." }, "insurance_payment_adjustment_total": { "type": "number", "format": "double", "description": "Total insurance payment adjustments." }, "patient_balance": { "type": "number", "format": "double", "description": "Balance owed by the patient." }, "patient_payment_adjustment_total": { "type": "number", "format": "double", "description": "Total patient payment adjustments." }, "total_balance": { "type": "number", "format": "double", "description": "Combined patient and insurance balance." } } }, "last_payment": { "description": "Details of the most recent payment.", "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Payment amount." }, "date": { "type": "string", "format": "date", "description": "Date the payment was made (yyyy-MM-dd).", "example": "2026-03-01" }, "description": { "type": "array", "description": "Description of the payment.", "example": [ "Patient payment" ], "items": { "type": "string" } }, "source": { "type": "string", "description": "Source of the payment (e.g., Patient, Insurance)." }, "code": { "type": "string", "description": "Payment code." }, "reference_number": { "type": "string", "description": "Reference number for the payment." } } }, "last_statement": { "description": "Details of the most recent billing statement.", "type": "object", "properties": { "balance": { "type": "number", "format": "double", "description": "Balance on the last statement." }, "date": { "type": "string", "format": "date", "description": "Date the statement was issued (yyyy-MM-dd).", "example": "2026-02-15" }, "type": { "description": "Type of the statement.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "view_status": { "type": "string", "description": "Indicates whether the statement has been viewed.", "example": "Viewed" } } }, "message": { "type": "string", "description": "Optional message associated with this billing section." }, "outstanding_account": { "description": "Outstanding account balance details. Populated for hospital billing and single billing office sections.", "type": "object", "properties": { "bad_debt_balance": { "type": "number", "format": "double", "description": "Balance in bad debt." }, "insurance_balance": { "type": "number", "format": "double", "description": "Balance owed by insurance." }, "last_self_pay_payment_date": { "type": "string", "format": "date", "description": "Date of the last self-pay payment (yyyy-MM-dd).", "example": "2026-03-15" }, "last_statement_date": { "type": "string", "format": "date", "description": "Date of the last statement (yyyy-MM-dd).", "example": "2026-02-28" }, "patient_balance": { "type": "number", "format": "double", "description": "Balance owed by the patient." }, "self_pay_followup_level": { "description": "Follow-up level for self-pay collections.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "total_balance": { "type": "number", "format": "double", "description": "Total outstanding balance." } } }, "payment_plan": { "description": "Active payment plan details, if any.", "type": "object", "properties": { "amount_due": { "type": "number", "format": "double", "description": "Current amount due under the payment plan." }, "monthly_amount_due": { "type": "number", "format": "double", "description": "Monthly payment amount." }, "next_due_date": { "type": "string", "format": "date", "description": "Date the next payment is due (yyyy-MM-dd).", "example": "2026-05-01" }, "number_of_payments_left": { "type": "string", "description": "Number of remaining payments.", "example": "6" }, "original_amount": { "type": "number", "format": "double", "description": "Original total amount of the payment plan." }, "remaining_amount": { "type": "number", "format": "double", "description": "Remaining balance of the payment plan." }, "start_date": { "type": "string", "format": "date", "description": "Date the payment plan started (yyyy-MM-dd).", "example": "2025-11-01" }, "is_late": { "type": "boolean", "description": "Whether the payment plan is past due." }, "overdue_amount": { "type": "number", "format": "double", "description": "Amount overdue on the payment plan." } } } } }, "single_billing_office": { "description": "Single billing office section, when combined billing applies.", "type": "object", "properties": { "aging_summaries": { "type": "array", "description": "List of aging bucket entries.", "items": { "type": "object", "description": "A single aging bucket entry.", "properties": { "amount": { "type": "number", "format": "double", "description": "Balance amount for this aging bucket." }, "display": { "type": "string", "description": "Human-readable label for the aging bucket.", "example": "0-30 days" } } } }, "balance_summary": { "description": "Summary of balances for this billing section.", "type": "object", "properties": { "amount_due": { "type": "number", "format": "double", "description": "Total amount currently due." }, "balance_not_on_payment_plan": { "type": "number", "format": "double", "description": "Balance not included in a payment plan." }, "balance_on_payment_plan": { "type": "number", "format": "double", "description": "Balance covered by an active payment plan." }, "charge_total": { "type": "number", "format": "double", "description": "Total charges." }, "insurance_balance": { "type": "number", "format": "double", "description": "Balance owed by insurance." }, "insurance_payment_adjustment_total": { "type": "number", "format": "double", "description": "Total insurance payment adjustments." }, "patient_balance": { "type": "number", "format": "double", "description": "Balance owed by the patient." }, "patient_payment_adjustment_total": { "type": "number", "format": "double", "description": "Total patient payment adjustments." }, "total_balance": { "type": "number", "format": "double", "description": "Combined patient and insurance balance." } } }, "last_payment": { "description": "Details of the most recent payment.", "type": "object", "properties": { "amount": { "type": "number", "format": "double", "description": "Payment amount." }, "date": { "type": "string", "format": "date", "description": "Date the payment was made (yyyy-MM-dd).", "example": "2026-03-01" }, "description": { "type": "array", "description": "Description of the payment.", "example": [ "Patient payment" ], "items": { "type": "string" } }, "source": { "type": "string", "description": "Source of the payment (e.g., Patient, Insurance)." }, "code": { "type": "string", "description": "Payment code." }, "reference_number": { "type": "string", "description": "Reference number for the payment." } } }, "last_statement": { "description": "Details of the most recent billing statement.", "type": "object", "properties": { "balance": { "type": "number", "format": "double", "description": "Balance on the last statement." }, "date": { "type": "string", "format": "date", "description": "Date the statement was issued (yyyy-MM-dd).", "example": "2026-02-15" }, "type": { "description": "Type of the statement.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "view_status": { "type": "string", "description": "Indicates whether the statement has been viewed.", "example": "Viewed" } } }, "message": { "type": "string", "description": "Optional message associated with this billing section." }, "outstanding_account": { "description": "Outstanding account balance details. Populated for hospital billing and single billing office sections.", "type": "object", "properties": { "bad_debt_balance": { "type": "number", "format": "double", "description": "Balance in bad debt." }, "insurance_balance": { "type": "number", "format": "double", "description": "Balance owed by insurance." }, "last_self_pay_payment_date": { "type": "string", "format": "date", "description": "Date of the last self-pay payment (yyyy-MM-dd).", "example": "2026-03-15" }, "last_statement_date": { "type": "string", "format": "date", "description": "Date of the last statement (yyyy-MM-dd).", "example": "2026-02-28" }, "patient_balance": { "type": "number", "format": "double", "description": "Balance owed by the patient." }, "self_pay_followup_level": { "description": "Follow-up level for self-pay collections.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "total_balance": { "type": "number", "format": "double", "description": "Total outstanding balance." } } }, "payment_plan": { "description": "Active payment plan details, if any.", "type": "object", "properties": { "amount_due": { "type": "number", "format": "double", "description": "Current amount due under the payment plan." }, "monthly_amount_due": { "type": "number", "format": "double", "description": "Monthly payment amount." }, "next_due_date": { "type": "string", "format": "date", "description": "Date the next payment is due (yyyy-MM-dd).", "example": "2026-05-01" }, "number_of_payments_left": { "type": "string", "description": "Number of remaining payments.", "example": "6" }, "original_amount": { "type": "number", "format": "double", "description": "Original total amount of the payment plan." }, "remaining_amount": { "type": "number", "format": "double", "description": "Remaining balance of the payment plan." }, "start_date": { "type": "string", "format": "date", "description": "Date the payment plan started (yyyy-MM-dd).", "example": "2025-11-01" }, "is_late": { "type": "boolean", "description": "Whether the payment plan is past due." }, "overdue_amount": { "type": "number", "format": "double", "description": "Amount overdue on the payment plan." } } } } }, "propensity_to_pay": { "description": "Propensity-to-pay category value for the guarantor.", "type": "object", "properties": { "abbreviation": { "type": "string", "description": "Short abbreviation for the category.", "example": "P" }, "number": { "type": "string", "description": "Numeric code for the category.", "example": "1" }, "title": { "type": "string", "description": "Full title of the category.", "example": "Patient" } } }, "service_area": { "description": "The service area associated with the guarantor.", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the service area.", "example": "Main Campus" }, "ids": { "type": "array", "description": "List of identifiers for the service area.", "items": { "type": "object", "description": "An identifier with a type label.", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Identifier value.", "example": "E100001" }, "type": { "type": "string", "description": "Identifier type (e.g., EPI, MRN, CSN).", "example": "EPI" } } } } } } } }, "examples": { "Guarantor billing summary": { "value": { "id": "2552", "account_ids": [ { "id": "E100001", "type": "EPI" } ], "account_type": { "abbreviation": "P", "number": "1", "title": "Patient" }, "billing_system": "Epic", "credit_score": "750", "is_confidential_guarantor": false, "is_paperless": true, "owning_deployment_descriptor": "MAIN", "patient_is_guarantor": true, "patients": [ { "date_of_birth": "1980-04-15", "legal_name": "Doe, John", "preferred_name": "John", "legal_sex": { "abbreviation": "M", "number": "1", "title": "Male" }, "gender_identity": "Male", "ids": [ { "id": "MRN12345", "type": "MRN" } ] } ], "professional_billing": { "aging_summaries": [ { "amount": 150, "display": "0-30 days" }, { "amount": 0, "display": "31-60 days" } ], "balance_summary": { "amount_due": 150, "balance_not_on_payment_plan": 150, "balance_on_payment_plan": 0, "charge_total": 200, "insurance_balance": 0, "insurance_payment_adjustment_total": 50, "patient_balance": 150, "patient_payment_adjustment_total": 0, "total_balance": 150 }, "last_payment": { "amount": 50, "date": "2026-03-01", "description": [ "Patient payment" ], "source": "Patient", "code": "PMNT", "reference_number": "REF001" }, "last_statement": { "balance": 200, "date": "2026-02-15", "type": { "abbreviation": "R", "number": "2", "title": "Regular" }, "view_status": "Viewed" } }, "hospital_billing": { "aging_summaries": [ { "amount": 300, "display": "0-30 days" } ], "balance_summary": { "amount_due": 300, "patient_balance": 250, "total_balance": 300 }, "outstanding_account": { "bad_debt_balance": 0, "insurance_balance": 50, "last_self_pay_payment_date": "2026-03-15", "last_statement_date": "2026-02-28", "patient_balance": 250, "self_pay_followup_level": { "abbreviation": "L1", "number": "1", "title": "Level 1" }, "total_balance": 300 } }, "propensity_to_pay": { "abbreviation": "H", "number": "3", "title": "High" }, "service_area": { "name": "Main Campus", "ids": [ { "id": "SA001", "type": "Internal" } ] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "examples": { "Generic Bad Request": { "value": { "code": "1484000", "message": "Bad request." } }, "Upstream Bad Request": { "value": { "code": "1484001", "message": "Bad Request in upstream." } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "examples": { "Invalid JWT": { "value": { "code": "1484010", "message": "Invalid JWT token." } }, "No Upstream": { "value": { "code": "1484012", "message": "No upstream selected." } }, "Upstream Unauthorized": { "value": { "code": "1484014", "message": "Unauthorized in upstream." } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "examples": { "Missing Scopes": { "value": { "code": "1484030", "message": "Required scopes are missing." } }, "Account Forbidden": { "value": { "code": "1484031", "message": "Account does not have access." } }, "Upstream Forbidden": { "value": { "code": "1484032", "message": "Forbidden in upstream." } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "examples": { "Not Found": { "value": { "code": "1484040", "message": "Resource not found." } }, "Upstream Not Found": { "value": { "code": "1484041", "message": "Not Found in upstream." } } } } } } } } } }, "components": { "securitySchemes": { "GA": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://{account_name}.talkdeskid.com/oauth/authorize", "tokenUrl": "https://{account_name}.talkdeskid.com/oauth/token", "scopes": { "account:read": "Show account details", "apps:read": "Get details about app installations for an account", "apps:write": "Update an app installation state programatically", "attributes:read": "List attributes or attribute categories for an account and get details for a specific attribute", "attributes:write": "Create, update and remove attributes or attributes categories for an account", "bulk-imports:read": "Get list of imports and export errors into CSV file", "bulk-imports:write": "Create and update import data", "messages:write": "Ability to send messages from the API", "callback:write": "Request a new direct callback", "contacts-integrations:read": "Get details for contacts' integrations", "contacts:read": "Get details for contact(s)", "contacts:write": "Create, update or delete contacts", "contact-gdpr:write": "GDPR Contacts", "continuity-settings:read": "Read business continuity settings", "continuity-settings:write": "Change business continuity settings", "continuity-settings-activation:read": "Read information on activation of the continuity settings", "continuity-settings-activation:write": "Edit information on activation of the continuity settings", "data-reports:read": "Download previously generated data reports", "data-reports:write": "Create new data reports", "data-tables:read": "Fetch and list data tables", "data-tables:write": "Create and update data tables", "data-tables-exports:read": "List and download data table exports", "data-tables-exports:write": "Create and cancel data table exports", "events:read": "Get details from received events", "express-provisioning:read": "Express-provisioning validate if account exists", "express-provisioning:write": "Provisioning of an account", "express-accounts-usage:read": "Read usage information for an account", "express-accounts:read": "Read account information", "express-accounts-contracts:read": "Get contract info for express accounts", "express-accounts-contracts-actions:write": "Create contract actions for express accounts", "express-accounts-contracts-actions:read": "Read contract actions of express accounts", "express-products:read": "Read product information", "express-accounts-subscriptions:read": "Read subscription information for an account", "express-accounts-invoices:read": "Read invoice information for an account", "erc-ecommerce-shopify-webhooks-handler-credentials:write": "Create or update Shopify webhook handler credentials", "erc-ecommerce-shopify-webhooks-handler-credentials:read": "Read Shopify webhook handler credentials", "flows-interactions:start": "Starts an interaction associated with a flow", "flows-platform:submit": "Trigger an automation flow associated with an account", "fsi-accounts:read": "List of accounts associated with a contact", "fsi-contacts:write": "Update contact information", "fsi-contacts:read": "List and get contact details", "fsi-cards:read": "List of cards from a account", "fsi-cards:write": "Update the status for a card", "fsi-payments:read": "List of payments from a specific account", "fsi-transactions:read": "List of transactions for a specific account", "fsi-payoff:read": "Get the payoff for an FSI account", "fsi-transfers:write": "Create an FSI Transfer", "fsi-stop-payment:write": "Cancel a payment before it’s been processed", "fsi-travel-notification:write": "Create a new endpoint for Travel Notifications", "fsi-checks:read": "Search for a check", "fsi-set-ach-transfer:write": "FSI Set ACH Transfer", "fsi-unlock-account:write": "Unlock account for a banking customer", "fsi-decrypt:read": "The decryption based on AES algorithm", "fsi-write-back:write": "FSI Write Data Back", "fsi-spend-limit:read": "Daily limit for reading debit cards", "fsi-spend-limit:write": "Modify the daily limit of debit cards", "guardian-call-quality:read": "Read Guardian call quality data.", "guardian-sessions:read": "Read Sessions Guardian data.", "guardian-users:read": "Read Users Guardian data.", "guardian-cases:read": "Read Cases Guardian data.", "identity-activity:read": "Identity activity read access", "identity-email-validation:read": "Identity Email Validation read access", "identity-ip-validation:read": "Identity IP Validation read access", "identity-phone-validation:read": "Identity Phone Validation read access", "openid": "User info endpoint", "recordings:read": "Get recording files", "recordings:delete": "Delete recording files", "refresh_token": "Token refresh flow", "reports:read": "List previously generated reports and download them", "reports:write": "Create new reports or delete existing ones", "queues:read": "List CCAAS queues", "queues:write": "Create/update CCAAS queues details", "queues-users:read": "List users assigned to a CCAAS queue", "users:read": "List users for an account and get details for a specific user", "users:write": "Create, Update and Delete users", "interactions:control-recordings": "Control the recording status of an interaction", "fsi-workspace-contact-synchronization:write": "Synchronize Talkdesk contact with fsi member information", "voicebiometrics-enroll:write": "Update and delete Voice Biometrics enroll data", "voicebiometrics-consent:read": "VoiceBiometrics consent read access", "voicebiometrics-consent:write": "VoiceBiometrics consent write access", "live-queries:read": "Read and list queries from Live API", "live-subscriptions:read": "Read subscriptions from Live API", "live-subscriptions:write": "Create a new subscription for Live API", "wfm-aion-public:write": "Create, Update and Delete WFM Aion related data by an external client.", "wfm-request-management-public:write": "Create, Update and Delete WFM Request Management related data by an external client.", "wfm-request-management-public:read": "Read WFM Request Management related data by an external client.", "account-wallets:read": "Get information about account wallets", "bucket-configurations:read": "Get all bucket configurations", "cases-public:write": "Create,update and delete case data", "cases-public:read": "Read case", "case-notes-public:read": "Read case note data", "case-notes-public:write": "Create, edit, and delete case note data", "case-fields-public:read": "Read case field", "do-not-call-lists:manage": "Update a DNCL by adding or deleting a entry on a do not call list", "do-not-call-lists:read": "Read entries in a do not call list", "record-lists:manage": "Ability to view, add and update records of a Record List", "record-lists:write": "Create and update record lists for an account", "role-permissions:skip": "Skip role permissions validation", "campaigns:write": "Create, update and delete campaigns", "campaigns:read": "List and view available campaigns", "schedule-callbacks:read": "List schedule callbacks", "schedule-callbacks:write": "schedule a callbacks or reschedule a callbacks", "po-record-list-automations:write": "Custom record list automations for proactive outbound clients", "prompts:read": "Read prompts", "prompts:write": "Create a prompt", "prompts:delete": "Delete a prompt", "prompts:download": "Get prompt download link", "webhooks-trigger:write": "Create, update and delete a webhook trigger", "cfm-public:write": "Collect feedback data", "digital-connect:read": "List and Get digital-connect Resources", "digital-connect:write": "Create, Update and Delete digital-connect Resources", "entitymapper-contact-interactions:write": "Update interaction's contact mappings", "locations-directory:read": "Read locations information", "locations-directory:write": "Write/update locations information and custom fields", "locations-directory:support": "Create/Update/Delete locations-directory support features", "staffs-directory:read": "Read staffs information", "staffs-directory:write": "Write/update staffs information", "automated-notifications-management:read": "Read Automated Notifications related account information", "automated-notifications-management:write": "Write Automated Notifications related account information", "automated-notifications:read": "Read Automated Notifications event information", "automated-notifications:write": "Write Automated Notifications event information", "automated-notifications-bridge:write": "Write permissions for automated-notifications-bridge webhooks", "automated-notifications-subscriptions:read": "Read Automated Notifications subscriptions related to a topic/channel", "automated-notifications-subscriptions:write": "Write (subscribe/unsubscribe) Automated Notifications subscriptions related to a topic/channel", "entitymapper-map:write": "Write mappings with external entities", "entitymapper-contacts:read": "Search Talkdesk contact", "entitymapper-contacts:write": "Write Talkdesk contact", "appointment-scheduling-va:read": "Read appointment scheduling va entries", "hls-coverage:read": "Read healthcare & life sciences coverage information", "hls-balance:read": "Read healthcare & life sciences balance information", "hls-patient:read": "Read healthcare & life sciences patient information", "hls-providers:call-answered": "Write healthcare & life sciences call answered information", "hls-appointment:read": "Read healthcare & life sciences patient appointments", "hls-medication-order:read": "Read healthcare & life sciences patient medication orders", "hls-appointment:write": "Write healthcare & life sciences patient appointments", "hls-contact:write": "Write healthcare & life sciences data into talkdesk contact", "hls-provider:read": "Read healthcare & life sciences provider appointments", "hls-phone-action:write": "Write healthcare & life sciences phone action", "hls-click-to-call:write": "Write healthcare & life sciences click-to-call action", "hls-epic-outgoing-sms:write": "Trigger outgoing SMS from Epic", "hls-epic-agent-status-sync:write": "Trigger agent status sync from Epic", "hls-inbasket-message:write": "Send in-basket message to Epic", "hls-popup-intent:write": "Save intent of a patient", "hls-prescription:read": "Read healthcare & life sciences prescription information", "hls-prescription:write": "Write healthcare & life sciences prescription information", "hls-encounter:read": "Read healthcare & life sciences patient encounters", "hls-service-request:read": "Read healthcare & life sciences patient service requests", "hls-procedure:read": "Read healthcare & life sciences patient procedures", "hls-payers-connections:read": "Read healthcare & life sciences payers information", "hls-payers-connections:write": "Write healthcare & life sciences payers information", "hls-symptom-checker:write": "Symptom checker for patient", "hls-patient:write": "Write healthcare & life sciences patient information", "hls-epic:call-answered": "Write healthcare & life sciences call answered information", "hls-sycurio:integrate": "Integrate with Sycurio platform", "hls-patient-case:write": "Write healthcare & life sciences patient case information", "hls-outstanding-order:read": "Read healthcare & life sciences outstanding orders", "hls-medication-order:write": "Write healthcare & life sciences medication order(request)", "hls-medication-statement:write": "Write healthcare & life sciences medication statement", "hls-medication-statement:read": "Read healthcare & life sciences medication statement", "hls-hl7-events:write": "Write healthcare providers HL7 events", "erc-ecommerce-connections-orders:write": "Update e-commerce connections orders info", "erc-ecommerce-connections-customers:read": "Read e-commerce connections customers info", "erc-ecommerce-connections-customers:write": "Write e-commerce connections customers info", "erc-ecommerce-connections-orders:read": "Read e-commerce connections orders info", "erc-ecommerce-connections-products:read": "Read e-commerce connections products info", "erc-ecommerce-customers:read": "Read e-commerce customers info", "erc-ecommerce-customers:write": "Write e-commerce customers info", "erc-ecommerce-return-reasons:read": "Read e-commerce return reasons", "erc-ecommerce-return:read": "Read e-commerce return info", "erc-ecommerce-return:write": "Write e-commerce return info", "erc-ecommerce-cart:write": "Sync e-commerce cart items", "erc-ecommerce-products:read": "Search e-commerce catalog products", "erc-ecommerce-orders:read": "Show e-commerce integrations orders info", "erc-ecommerce-orders:write": "Update e-commerce integrations orders info", "erc-ecommerce-recall:write": "Write e-commerce recall contacts", "industries-settings-public:write": "Write industries settings", "industries-contexts:write": "Create, update, and delete context values", "fsi-insurance-connections-automated-notifications:write": "Write Automated Notifications event information", "fsi-insurance-connections-contacts:write": "Sync Talkdesk contacts", "fsi-insurance-connections-claims:read": "Read claims by id from FSI Insurance", "fsi-insurance-integrations-policies:read": "Read policies from FSI Insurance", "fsi-insurance-integrations-accounts:read": "Read accounts from FSI Insurance", "fsi-insurance-integrations-claims:write": "Write claims from FSI Insurance", "fsi-insurance-integrations-billing:read": "Read billing info from FSI Insurance", "fsi-insurance-integrations-claims:read": "Read claims from FSI Insurance", "fsi-insurance-integrations-contacts:write": "Update contact details from FSI Insurance", "fsi-insurance-integrations-send-docs:read": "Send document deliveries from FSI Insurance", "fsi-insurance-integrations-data-back:write": "Write contact event data back to FSI Insurance", "automated-notifications-interactions:read": "Read Automated Notifications related with interactions", "industries-scheduler-teams:read": "Read teams from industries-scheduler", "industries-scheduler-availabilities:read": "Get users availabilities by email", "industries-scheduler-appointment:write": "Create cancel event on specialist's calendar", "industries-scheduler-appointment:read": "Read appointments from industries-scheduler", "industries-messaging-service:write": "Write messages in industries-messaging-service", "interaction-custom-fields:write": "Allows to populate interaction custom fields", "user-session-public:end": "Terminate a user session", "industries-settings-public:read": "Read industries settings", "industries-contexts:read": "Read context values", "dialer-integrations-records:read": "Read dialer integrations campaign records", "scim": "Access SCIM-related routes", "hls-epic-my-chart-reset-password:write": "Trigger Epic MyChart password reset (Deprecated - use hls-patient-password-reset:write)", "hls-patient-password-reset:write": "Trigger patient password reset for healthcare portal", "locations-directory-bulk-operation:write": "Write locations directory data", "locations-directory-batch-operation:write": "Apply a batch of locations directory create/update/delete operations", "hls-patient-location:read": "Read loction patient data", "hls-patient-practice:read": "Read healthcare & life sciences patient practices", "hls-guarantor:read": "Read guarantor identifiers from providers", "hls-guarantor-billing:read": "Read guarantor billing summary from providers", "hls-guarantor-password-reset:write": "Trigger guarantor password reset for healthcare portal", "hls-patient-billing:read": "Read patient billing details from providers", "hls-interaction-overrides:write": "Write healthcare & life sciences interaction-specific configuration overrides", "industries-workflows:read": "Read industries workflow schedules and workflows", "industries-workflows:write": "Create, update, start, and delete industries workflow schedules and workflows", "digital-messaging-adapter:write": "Write or update Digital Messaging Adapter data" } } } } } }, "externalDocs": { "description": "External Documentation", "url": "https://api-docs.talkdeskapp.com/external_docs" } } ```