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
On this page
Methods
client.payments.list#
readasync 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
| Parameter | Type | Description |
|---|---|---|
practice_id | int | str | None | Filter by practice ID (sent as a string). |
practice_name | str | None | Filter by practice name. |
payment_id | int | str | None | Filter by payment ID (sent as ID). |
payer_name | str | None | Payer name filter. |
payer_type | str | None | Payer type filter. |
appointment_id | int | str | None | Filter by appointment ID. |
batch_number | str | None | Batch number filter. |
reference_number | str | None | Reference number filter. |
amount | str | float | None | Amount filter (sent as a string). |
from_post_date | str | date | datetime | None | Lower posting date. |
to_post_date | str | date | datetime | None | Upper posting date. |
from_created_date | str | date | datetime | None | Lower creation-date bound. |
to_created_date | str | date | datetime | None | Upper creation-date bound. |
from_last_modified_date | str | date | datetime | None | Lower last-modified bound. |
to_last_modified_date | str | date | datetime | None | Upper last-modified bound. |
fields | Iterable[str] | Mapping[str, bool] | None | Field selector. |
extra_filter | Mapping[str, Any] | None | Additional raw Filter keys. |
Returns
list[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#
readasync 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
| Parameter | Type | Description |
|---|---|---|
practice_name | str | None | Practice name filter. |
practice_id | int | str | None | Practice ID; resolved to PracticeName. |
procedure_code | str | None | Procedure code filter. |
payer_type | str | None | Payer type filter. |
transaction_type | str | None | Transaction type (sent as Type). |
insurance_order | str | None | Insurance order filter. |
from_service_date | str | date | datetime | None | Lower service date. |
to_service_date | str | date | datetime | None | Upper service date. |
from_posting_date | str | date | datetime | None | Lower posting date. |
to_posting_date | str | date | datetime | None | Upper posting date. |
from_transaction_date | str | date | datetime | None | Lower transaction date. |
to_transaction_date | str | date | datetime | None | Upper transaction date. |
from_last_modified_date | str | date | datetime | None | Lower last-modified bound. |
to_last_modified_date | str | date | datetime | None | Upper last-modified bound. |
fields | Iterable[str] | Mapping[str, bool] | None | Field selector. |
extra_filter | Mapping[str, Any] | None | Additional raw Filter keys. |
Returns
list[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#
writeasync create(payment) -> dictPost a new payment using CreatePayment. Blocked when read_only=True.
Parameters
| Parameter | Type | Description |
|---|---|---|
paymentrequired | Mapping[str, Any] | Raw Payment payload. |
Returns
dict[str, Any] (the SOAP response)