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#
readasync 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
| Parameter | Type | Description |
|---|---|---|
sync_client_throttler | bool | Apply the returned intervals to the client throttler. Default True. |
Returns
list[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#
readasync get_customer_id() -> dictResolve 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.
Returns
dict[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#
readasync list_external_vendors() -> list[dict]List registered external vendors using GetExternalVendors.
Returns
list[dict[str, Any]] (id key ExternalVendorID)client.system.register_external_vendor#
writeasync register_external_vendor(vendor_name) -> dictRegister a new external vendor using RegisterExternalVendor. Blocked when read_only=True.
Parameters
| Parameter | Type | Description |
|---|---|---|
vendor_namerequired | str | External vendor name. |
Returns
dict[str, Any] (the created vendor or raw response)