Skip to main content
POST
Record an inbound check

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

caseId
string
required

Case id

Query Parameters

organizationId
string<uuid>

Select one organization for this request. Defaults to the key organization. An HQ key may select an active descendant when its active acting attorney has the required HQ and resource permissions. Repeat the same organizationId on related mutations, upload completion, detail requests, and every cursor page. See /authorization.

Body

application/json
amountCents
integer
required
Required range: 0 <= x <= 100000000000
checkType
enum<string>
required
Available options:
settlement_proceeds,
medical_reimbursement,
lien_payment,
expense_reimbursement,
attorney_fee_payment,
third_party_payment,
client_reimbursement,
insurance_refund,
recurring_wage_loss,
direct_to_client,
other
dateReceived
string
required
status
enum<string>
default:received_pending

Use deposited to record a receipt already deposited; depositDate is then required.

Available options:
received_pending,
deposited
allocations
object[]

Optional allocation rows saved atomically with the receipt. Allocations require status deposited. Amounts are integer cents and may not exceed amountCents. Expense recoveries must reference paid, nondeleted expenses on this case and may not exceed their unrecovered balance. Does not create vendor payments.

Maximum array length: 200
depositDate
string
checkNumber
string
Required string length: 1 - 100
payorContactId
string
Required string length: 1 - 200
payorName
string
Required string length: 1 - 500
resolutionId
string
Required string length: 1 - 200
deliveryMethod
enum<string>
Available options:
wire,
print,
ach,
other
notes
string
Maximum string length: 10000

Response

{ success: true, check }

success
boolean
required
{key}
any