Ttebra_soap_apiAsync Tebra SOAP 2.1
SOAP 2.1
Resources

Payments

Read payments and ledger transactions, or post a payment when the client is writable.

Resource
client.payments
SOAP operations
GetPayments, GetTransactions, CreatePayment
Flat methods
get_payments, get_transactions
Default throttle
1000 ms for GetTransactions

Methods

client.payments.list#

read
async list(*, practice_id=None, practice_name=None, payment_id=None, payer_name=None, payer_type=None, appointment_id=None, batch_number=None, reference_number=None, amount=None, from_post_date=None, to_post_date=None, from_created_date=None, to_created_date=None, from_last_modified_date=None, to_last_modified_date=None, fields=None, extra_filter=None) -> list[dict]

Query payments using GetPayments.

Parameters
ParameterTypeDescription
practice_idint | str | NoneFilter by practice ID (sent as a string).
practice_namestr | NoneFilter by practice name.
payment_idint | str | NoneFilter by payment ID (sent as ID).
payer_namestr | NonePayer name filter.
payer_typestr | NonePayer type filter.
appointment_idint | str | NoneFilter by appointment ID.
batch_numberstr | NoneBatch number filter.
reference_numberstr | NoneReference number filter.
amountstr | float | NoneAmount filter (sent as a string).
from_post_datestr | date | datetime | NoneLower posting date.
to_post_datestr | date | datetime | NoneUpper posting date.
from_created_datestr | date | datetime | NoneLower creation-date bound.
to_created_datestr | date | datetime | NoneUpper creation-date bound.
from_last_modified_datestr | date | datetime | NoneLower last-modified bound.
to_last_modified_datestr | date | datetime | NoneUpper last-modified bound.
fieldsIterable[str] | Mapping[str, bool] | NoneField selector.
extra_filterMapping[str, Any] | NoneAdditional raw Filter keys.
Returnslist[dict[str, Any]]
Example
payments = await client.get_payments(
    practice_id=7,
    from_post_date="2026-04-01",
    to_post_date="2026-04-30",
)

client.payments.list_transactions#

read
async list_transactions(*, practice_name=None, practice_id=None, procedure_code=None, payer_type=None, transaction_type=None, insurance_order=None, from_service_date=None, to_service_date=None, from_posting_date=None, to_posting_date=None, from_transaction_date=None, to_transaction_date=None, from_last_modified_date=None, to_last_modified_date=None, fields=None, extra_filter=None) -> list[dict]

Query financial ledger transactions using GetTransactions. Accepts practice_name or practice_id, resolved automatically.

Parameters
ParameterTypeDescription
practice_namestr | NonePractice name filter.
practice_idint | str | NonePractice ID; resolved to PracticeName.
procedure_codestr | NoneProcedure code filter.
payer_typestr | NonePayer type filter.
transaction_typestr | NoneTransaction type (sent as Type).
insurance_orderstr | NoneInsurance order filter.
from_service_datestr | date | datetime | NoneLower service date.
to_service_datestr | date | datetime | NoneUpper service date.
from_posting_datestr | date | datetime | NoneLower posting date.
to_posting_datestr | date | datetime | NoneUpper posting date.
from_transaction_datestr | date | datetime | NoneLower transaction date.
to_transaction_datestr | date | datetime | NoneUpper transaction date.
from_last_modified_datestr | date | datetime | NoneLower last-modified bound.
to_last_modified_datestr | date | datetime | NoneUpper last-modified bound.
fieldsIterable[str] | Mapping[str, bool] | NoneField selector.
extra_filterMapping[str, Any] | NoneAdditional raw Filter keys.
Returnslist[dict[str, Any]]
Example
transactions = await client.get_transactions(
    practice_id=7,
    from_service_date="2026-04-01",
    to_service_date="2026-04-30",
)

client.payments.create#

write
async create(payment) -> dict

Post a new payment using CreatePayment. Blocked when read_only=True.

Parameters
ParameterTypeDescription
paymentrequiredMapping[str, Any]Raw Payment payload.
Returnsdict[str, Any] (the SOAP response)

Related