Ttebra_soap_apiAsync Tebra SOAP 2.1
SOAP 2.1
Resources

System

Account metadata, live throttle intervals, and external vendor management.

Resource
client.system
SOAP operations
GetThrottles, GetCustomerIdFromKey, GetExternalVendors, RegisterExternalVendor
Flat methods
get_throttles, get_customer_id
Default throttle
5000 ms for GetThrottles

Methods

client.system.get_throttles#

read
async get_throttles(*, sync_client_throttler=True) -> list[dict]

Fetch live per-endpoint throttle intervals using GetThrottles. When sync_client_throttler=True, the client's EndpointThrottler is updated with the server-reported values.

Parameters
ParameterTypeDescription
sync_client_throttlerboolApply the returned intervals to the client throttler. Default True.
Returnslist[dict[str, Any]] with Endpoint and ThrottleTimeMs.
Example
details = await client.get_throttles()
for row in details:
    print(row["Endpoint"], row["ThrottleTimeMs"])

client.system.get_customer_id#

read
async get_customer_id() -> dict

Resolve the numeric CustomerId and authorization state from the configured CustomerKey using GetCustomerIdFromKey. This call is dispatched without a request header, matching Tebra's WSDL. Raises TebraAuthError when IsAuthorized=False.

Returnsdict[str, Any] including IsAuthorized and customer identifiers.
Example
info = await client.get_customer_id()
print(info["IsAuthorized"], info.get("CustomerId"))

client.system.list_external_vendors#

read
async list_external_vendors() -> list[dict]

List registered external vendors using GetExternalVendors.

Returnslist[dict[str, Any]] (id key ExternalVendorID)

client.system.register_external_vendor#

write
async register_external_vendor(vendor_name) -> dict

Register a new external vendor using RegisterExternalVendor. Blocked when read_only=True.

Parameters
ParameterTypeDescription
vendor_namerequiredstrExternal vendor name.
Returnsdict[str, Any] (the created vendor or raw response)

Related