Skip to main content
POST
/
api
/
v2
/
ledger
/
entry
Python
from samplehc import SampleHealthcare

client = SampleHealthcare(
    api_key="My API Key",
)
response = client.v2.ledger.entry.post(
    amount_usd_cents=0,
    entry_category="charge",
    line_item_id="lineItemId",
    order_id="orderId",
)
print(response.success)
{
  "success": true
}

Headers

​
idempotency-key
string

A unique identifier for the event. If the same event is sent with the same idempotency key, the event will be ignored.

Body

application/json
​
entryCategory
enum<string>
required
Available options:
charge,
payment,
adjustment
​
amountUsdCents
number
required

The amount of the ledger entry in cents. Positive for charges, negative for payments.

​
orderId
string
required

The order ID associated with the ledger entry.

​
lineItemId
string
required

The line item ID associated with the ledger entry.

​
entryType

The type of ledger entry.

Available options:
insurance-payment,
institution-payment,
patient-payment,
write-off,
institution-discount,
contracted-payer-adjustment,
patient-pay-adjustment,
charge,
payment,
adjustment
​
description
string

The description of the ledger entry.

​
postedAt
string

The date and time the ledger entry was posted.

​
paymentSource
string

The source of the payment, e.g. payer ID, patient ID, etc.

​
metadata
object

Any optional metadata to associate with the ledger entry.

Response

Default Response

​
success
boolean
required

Whether the event was emitted successfully.