Update Transaction

patch

https://unify.kolla.dev/dental/v1/transactions/{transaction}

Updates an existing transaction in the remote practice management system. Only fields specified in the update mask will be modified.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

transaction

string

required

The transaction id.

Query Params

update_mask

string

Optional. Only the fields specified in the mask will be updated. If omitted, all fields included in the request body are updated.

Body Params

A transaction represents a financial event on a patient account, such as a procedure charge, payment, or adjustment, synchronized from a dental practice management system.

contact

string

required

^contacts/.+$

The patient associated with this transaction (format: contacts/{contact}).

provider

string

^resources/.+$

The dental provider (e.g., dentist or hygienist) who performed or is associated with this transaction (format: resources/{resource}). On create, defaults to the patient's primary provider when omitted.

amount

string

required

^-?\d+(\.\d{1,})?$

The transaction amount as a decimal string in dollars (e.g., '125.50'). Payments are credits and are negative (a $50 payment is '-50.00'); the same convention applies on create, so a positive payment amount is a refund. Adjustments are positive for debits and negative for credits.

note

string

A free-text note or description attached to the transaction by the dental practice.

transaction_type

string

enum

required

The high-level type of the transaction (procedure, payment, adjustment, or account charge). On create, only PAYMENT and ADJUSTMENT are supported; insurance payments are created with CreateClaimPayment.

Allowed:

custom_type

string

The user-defined type for this transaction, referencing a practice-specific configuration such as an adjustment type or payment type (format: customtypes/{custom_type}). On create, must be a type of the matching category (see ListCustomTypes); defaults to the practice's first visible type when omitted.

procedure

string

The procedure that this transaction is associated with (format: procedures/{procedure}). On create, the payment or adjustment is attached to this procedure, which must belong to the contact.

location

string

^resources/.+$

The practice location where the transaction occurred, only populated for multi-location practice management systems (format: resources/{resource}). On create, defaults to the consumer's configured location when omitted.

additional_data

object

Additional data for the transaction, specific to the source practice management system. On create, Open Dental payments accept check_number, bank_branch, and unearned_type (a paysplit unearned type definition number).

transaction_date

string

^\d{4}-\d{2}-\d{2}$

The transaction date as a date-only string without a time component (format: YYYY-MM-DD). On create, defaults to today in the practice's timezone when omitted.

hash

string

An optional hash value used for change detection on the transaction record.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response