Supports one selected organization via organizationId. Omit it to use the key’s organization. HQ descendant access requires an active acting attorney with hq:view_child_orgs, cases:view, cases:view_all, hq:view_all_cases, accounting:view, accounting:view_all, hq:view_all_accounting, settlements:view, disbursements:view, hq:manage_child_orgs, accounting:process_payments, settlements:edit. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See HQ authorization.
Requires the funds:write scope. Mutations require an X-Idempotency-Key header (responses are stored for replay; reusing a key with a different request returns 409 IDEMPOTENCY_CONFLICT). Rate tier: write.
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
Show child attributes
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
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Presolve Documentation","description":"Help for Presolve users, developer integration guides, and API reference.","colors":{"primary":"#334E68","light":"#627D98","dark":"#627D98"},"logo":{"light":"https://mintcdn.com/grand-charter/kgY2Gushfw80fPEZ/images/presolve-logo-light.svg?fit=max\u0026auto=format\u0026n=kgY2Gushfw80fPEZ\u0026q=85\u0026s=e9ba70b57f4e3c87a6dc5c3dce12cdec","dark":"https://mintcdn.com/grand-charter/kgY2Gushfw80fPEZ/images/presolve_logo_2.svg?fit=max\u0026auto=format\u0026n=kgY2Gushfw80fPEZ\u0026q=85\u0026s=cfe20825a75066df6a1608ee4ed8e473","href":"https://www.presolve.com/"},"favicon":{"light":"https://mintcdn.com/grand-charter/kgY2Gushfw80fPEZ/images/presolve-logo-light.svg?fit=max\u0026auto=format\u0026n=kgY2Gushfw80fPEZ\u0026q=85\u0026s=e9ba70b57f4e3c87a6dc5c3dce12cdec","dark":"https://mintcdn.com/grand-charter/kgY2Gushfw80fPEZ/images/presolve_logo_2.svg?fit=max\u0026auto=format\u0026n=kgY2Gushfw80fPEZ\u0026q=85\u0026s=cfe20825a75066df6a1608ee4ed8e473"},"api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"appearance":{"default":"system"},"footer":{"socials":{}},"seo":{"metatags":{"canonical":"https://www.presolve.com/docs"}},"fonts":{"heading":{"family":"ABC Diatype","weight":700,"source":"fonts/ABCDiatype-Bold.woff2","format":"woff2"},"body":{"family":"ABC Diatype","weight":400,"source":"fonts/ABCDiatype-Regular.woff2","format":"woff2"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"grand-charter","hasAudioNarration":false,"actualSubdomain":"grand-charter","customDomains":["www.presolve.com"],"gitSource":{"type":"github","owner":"grandcharter","repo":"grand-charter","deployBranch":"docs-live","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aff86df283455f42d7cde0a","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":203},{"language":"default","tag":"Help Center","count":102},{"language":"default","tag":"Documents","count":26},{"language":"default","tag":"Billing","count":21},{"language":"default","tag":"Accounting","count":19},{"language":"default","tag":"Integrations","count":19},{"language":"default","tag":"Cases","count":16},{"language":"default","tag":"Settlement Funds","count":14},{"language":"default","tag":"Developer Guides","count":13},{"language":"default","tag":"Organization administration","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/settlement-funds/record-an-inbound-check","slug":"/api-reference/settlement-funds/record-an-inbound-check","pageMetadata":{"title":"Record an inbound check","description":"Supports one selected organization via `organizationId`. Omit it to use the key's organization. HQ descendant access requires an active acting attorney with `hq:view_child_orgs`, `cases:view`, `cases:view_all`, `hq:view_all_cases`, `accounting:view`, `accounting:view_all`, `hq:view_all_accounting`, `settlements:view`, `disbursements:view`, `hq:manage_child_orgs`, `accounting:process_payments`, `settlements:edit`. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See [HQ authorization](/authorization).\n\nRequires the `funds:write` scope. Mutations require an `X-Idempotency-Key` header (responses are stored for replay; reusing a key with a different request returns 409 `IDEMPOTENCY_CONFLICT`). Rate tier: `write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/checks","href":"/api-reference/settlement-funds/record-an-inbound-check","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Supports one selected organization via \", _jsx(_components.code, {\n children: \"organizationId\"\n }), \". Omit it to use the key’s organization. HQ descendant access requires an active acting attorney with \", _jsx(_components.code, {\n children: \"hq:view_child_orgs\"\n }), \", \", _jsx(_components.code, {\n children: \"cases:view\"\n }), \", \", _jsx(_components.code, {\n children: \"cases:view_all\"\n }), \", \", _jsx(_components.code, {\n children: \"hq:view_all_cases\"\n }), \", \", _jsx(_components.code, {\n children: \"accounting:view\"\n }), \", \", _jsx(_components.code, {\n children: \"accounting:view_all\"\n }), \", \", _jsx(_components.code, {\n children: \"hq:view_all_accounting\"\n }), \", \", _jsx(_components.code, {\n children: \"settlements:view\"\n }), \", \", _jsx(_components.code, {\n children: \"disbursements:view\"\n }), \", \", _jsx(_components.code, {\n children: \"hq:manage_child_orgs\"\n }), \", \", _jsx(_components.code, {\n children: \"accounting:process_payments\"\n }), \", \", _jsx(_components.code, {\n children: \"settlements:edit\"\n }), \". Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See \", _jsx(_components.a, {\n href: \"/authorization\",\n children: \"HQ authorization\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the \", _jsx(_components.code, {\n children: \"funds:write\"\n }), \" scope. Mutations require an \", _jsx(_components.code, {\n children: \"X-Idempotency-Key\"\n }), \" header (responses are stored for replay; reusing a key with a different request returns 409 \", _jsx(_components.code, {\n children: \"IDEMPOTENCY_CONFLICT\"\n }), \"). Rate tier: \", _jsx(_components.code, {\n children: \"write\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Record an inbound check","description":"Supports one selected organization via `organizationId`. Omit it to use the key's organization. HQ descendant access requires an active acting attorney with `hq:view_child_orgs`, `cases:view`, `cases:view_all`, `hq:view_all_cases`, `accounting:view`, `accounting:view_all`, `hq:view_all_accounting`, `settlements:view`, `disbursements:view`, `hq:manage_child_orgs`, `accounting:process_payments`, `settlements:edit`. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See [HQ authorization](/authorization).\n\nRequires the `funds:write` scope. Mutations require an `X-Idempotency-Key` header (responses are stored for replay; reusing a key with a different request returns 409 `IDEMPOTENCY_CONFLICT`). Rate tier: `write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/checks","href":"/api-reference/settlement-funds/record-an-inbound-check","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"post_cases_ByCaseId_checks","tags":["Settlement Funds"],"summary":"Record an inbound check","description":"Supports one selected organization via `organizationId`. Omit it to use the key's organization. HQ descendant access requires an active acting attorney with `hq:view_child_orgs`, `cases:view`, `cases:view_all`, `hq:view_all_cases`, `accounting:view`, `accounting:view_all`, `hq:view_all_accounting`, `settlements:view`, `disbursements:view`, `hq:manage_child_orgs`, `accounting:process_payments`, `settlements:edit`. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See [HQ authorization](/authorization).\n\nRequires the `funds:write` scope. Mutations require an `X-Idempotency-Key` header (responses are stored for replay; reusing a key with a different request returns 409 `IDEMPOTENCY_CONFLICT`). Rate tier: `write`.","security":["5eb672f8-5a4b-4e42-94a7-3547b64befdb"],"x-organization-scope":"selected-organization","x-required-scope":"funds:write","x-rate-limit-tier":"write","parameters":["15ef36ff-14fb-486d-92ec-cb935db7bf0b","8fdd5aff-b2fd-440a-a236-7aceb7b07d69","c06735f9-b540-4d17-95f4-4d061d91d038"],"requestBody":"09de87ce-1050-451a-b235-6debf6d99a03","responses":{"201":"444fd875-62bc-4ede-b314-f8374d7ebef6","400":"adcd3231-df77-41e5-8cdf-6b75a0eb4815","401":"06efe0d6-121e-4d85-bf12-0b0a3eb0a27d","403":"ef4f0f65-da56-42a8-b11b-9bf0dfe42aeb","404":"eaf7a60a-deb3-4f6c-92f1-fa06972ac374","409":"2f17ad13-03ca-4622-81b5-17a91724856d","429":"ec536671-58fe-45d1-9072-e8d2794ff82d"},"method":"post","type":"path","servers":["c8e7e4e7-df75-40fa-b7a0-9b44892236e2"],"path":"/api/v1/cases/{caseId}/checks","baseUrlOptions":["https://www.presolve.com"],"title":"Record an inbound check","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"15ef36ff-14fb-486d-92ec-cb935db7bf0b":{"name":"X-Idempotency-Key","in":"header","required":true,"description":"Stable caller-chosen key (max 200 chars) making the mutation safely retryable.","schema":{"type":"string","maxLength":200,"isRequired":true,"description":"Stable caller-chosen key (max 200 chars) making the mutation safely retryable.","uniqueKey":"","typeLabel":"string"}},"8fdd5aff-b2fd-440a-a236-7aceb7b07d69":{"in":"path","name":"caseId","description":"Case id","schema":{"type":"string","description":"Case id","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"c06735f9-b540-4d17-95f4-4d061d91d038":{"in":"query","name":"organizationId","description":"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.","schema":{"type":"string","format":"uuid","description":"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.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountCents":{"type":"integer","minimum":0,"maximum":100000000000,"isRequired":true,"uniqueKey":"amountCents","typeLabel":"integer"},"checkType":{"type":"string","enum":["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"],"isRequired":true,"uniqueKey":"checkType","typeLabel":"enum\u003cstring>"},"dateReceived":{"type":"string","isRequired":true,"uniqueKey":"dateReceived","typeLabel":"string"},"status":{"type":"string","enum":["received_pending","deposited"],"default":"received_pending","description":"Use deposited to record a receipt already deposited; depositDate is then required.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"allocations":{"type":"array","items":{"type":"object","properties":{"allocationType":{"type":"string","enum":["case_expense","attorney_fee","client_recovery","firm_operating_revenue"],"isRequired":true,"uniqueKey":"allocations.items.[INDEX].allocationType","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647,"isRequired":true,"uniqueKey":"allocations.items.[INDEX].amount","typeLabel":"integer"},"linkedExpenseId":{"type":"string","minLength":1,"uniqueKey":"allocations.items.[INDEX].linkedExpenseId","typeLabel":"string"},"description":{"type":"string","maxLength":1000,"uniqueKey":"allocations.items.[INDEX].description","typeLabel":"string"}},"required":["allocationType","amount"],"additionalProperties":false,"uniqueKey":"allocations.items.[INDEX]","typeLabel":"object"},"maxItems":200,"default":[],"description":"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.","uniqueKey":"allocations","typeLabel":"object[]"},"depositDate":{"type":"string","uniqueKey":"depositDate","typeLabel":"string"},"checkNumber":{"type":"string","minLength":1,"maxLength":100,"uniqueKey":"checkNumber","typeLabel":"string"},"payorContactId":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"payorContactId","typeLabel":"string"},"payorName":{"type":"string","minLength":1,"maxLength":500,"uniqueKey":"payorName","typeLabel":"string"},"resolutionId":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"resolutionId","typeLabel":"string"},"deliveryMethod":{"type":"string","enum":["wire","print","ach","other"],"uniqueKey":"deliveryMethod","typeLabel":"enum\u003cstring>"},"notes":{"type":"string","maxLength":10000,"uniqueKey":"notes","typeLabel":"string"}},"required":["amountCents","checkType","dateReceived"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amountCents":50000000000,"dateReceived":"\u003cstring>","status":"received_pending","allocations":[],"depositDate":"\u003cstring>","checkNumber":"\u003cstring>","payorContactId":"\u003cstring>","payorName":"\u003cstring>","resolutionId":"\u003cstring>","notes":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"444fd875-62bc-4ede-b314-f8374d7ebef6":{"description":"{ success: true, check }","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"}},"required":["success"],"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true}}},"exampleType":"generated"}},"exampleType":"generated"},"adcd3231-df77-41e5-8cdf-6b75a0eb4815":{"description":"Validation failed (VALIDATION_FAILED).","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Human-readable error message. 5xx responses are always scrubbed to \"Internal server error\".","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code (ErrorCode), e.g. UNAUTHORIZED, FORBIDDEN, VALIDATION_FAILED, NOT_FOUND, INVALID_STATE_TRANSITION, DUPLICATE_ENTRY, STALE_REVISION, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_CONFLICT, RATE_LIMITED, INTERNAL_ERROR.","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"06efe0d6-121e-4d85-bf12-0b0a3eb0a27d":{"description":"Missing, invalid, or expired API key (UNAUTHORIZED).","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Human-readable error message. 5xx responses are always scrubbed to \"Internal server error\".","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code (ErrorCode), e.g. UNAUTHORIZED, FORBIDDEN, VALIDATION_FAILED, NOT_FOUND, INVALID_STATE_TRANSITION, DUPLICATE_ENTRY, STALE_REVISION, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_CONFLICT, RATE_LIMITED, INTERNAL_ERROR.","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ef4f0f65-da56-42a8-b11b-9bf0dfe42aeb":{"description":"API key lacks the required scope, or the selected organization is not authorized (FORBIDDEN).","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Human-readable error message. 5xx responses are always scrubbed to \"Internal server error\".","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code (ErrorCode), e.g. UNAUTHORIZED, FORBIDDEN, VALIDATION_FAILED, NOT_FOUND, INVALID_STATE_TRANSITION, DUPLICATE_ENTRY, STALE_REVISION, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_CONFLICT, RATE_LIMITED, INTERNAL_ERROR.","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"eaf7a60a-deb3-4f6c-92f1-fa06972ac374":{"description":"Resource not found in the caller’s organization (NOT_FOUND).","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Human-readable error message. 5xx responses are always scrubbed to \"Internal server error\".","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code (ErrorCode), e.g. UNAUTHORIZED, FORBIDDEN, VALIDATION_FAILED, NOT_FOUND, INVALID_STATE_TRANSITION, DUPLICATE_ENTRY, STALE_REVISION, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_CONFLICT, RATE_LIMITED, INTERNAL_ERROR.","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"2f17ad13-03ca-4622-81b5-17a91724856d":{"description":"Conflict: invalid state transition, duplicate entry, stale revision, or idempotency conflict.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Human-readable error message. 5xx responses are always scrubbed to \"Internal server error\".","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code (ErrorCode), e.g. UNAUTHORIZED, FORBIDDEN, VALIDATION_FAILED, NOT_FOUND, INVALID_STATE_TRANSITION, DUPLICATE_ENTRY, STALE_REVISION, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_CONFLICT, RATE_LIMITED, INTERNAL_ERROR.","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ec536671-58fe-45d1-9072-e8d2794ff82d":{"description":"Rate limit exceeded (RATE_LIMITED). Honor Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Human-readable error message. 5xx responses are always scrubbed to \"Internal server error\".","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code (ErrorCode), e.g. UNAUTHORIZED, FORBIDDEN, VALIDATION_FAILED, NOT_FOUND, INVALID_STATE_TRANSITION, DUPLICATE_ENTRY, STALE_REVISION, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_CONFLICT, RATE_LIMITED, INTERNAL_ERROR.","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5eb672f8-5a4b-4e42-94a7-3547b64befdb":{"integrationApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.","scopes":[],"schemeName":"integrationApiKey"}}},"servers":{"c8e7e4e7-df75-40fa-b7a0-9b44892236e2":{"url":"https://www.presolve.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.","scopes":[],"schemeName":"integrationApiKey"},"schema":{"title":"x-api-key","type":"string","description":"Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"integrationApiKey","name":"x-api-key"}],"title":"integrationApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"grand-charter","siteName":"Presolve Documentation","title":"Record an inbound check - Presolve Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T19:49:56.055Z","originalFileLocation":"api-reference/settlement-funds/record-an-inbound-check.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Supports one selected organization via organizationId. Omit it to use the key\u0026#x27;s organization. HQ descendant access requires an active acting attorney with hq:view_child_orgs, cases:view, cases:view_all, hq:view_all_cases, accounting:view, accounting:view_all, hq:view_all_accounting, settlements:view, disbursements:view, hq:manage_child_orgs, accounting:process_payments, settlements:edit. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See HQ authorization. Requires the funds:write scope. Mutations require an X-Idempotency-Key header (responses are stored for replay; reusing a key with a different request returns 409 IDEMPOTENCY_CONFLICT). Rate tier: write.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Presolve Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Record an inbound check - Presolve Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Supports one selected organization via organizationId. Omit it to use the key\u0026#x27;s organization. HQ descendant access requires an active acting attorney with hq:view_child_orgs, cases:view, cases:view_all, hq:view_all_cases, accounting:view, accounting:view_all, hq:view_all_accounting, settlements:view, disbursements:view, hq:manage_child_orgs, accounting:process_payments, settlements:edit. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See HQ authorization. Requires the funds:write scope. Mutations require an X-Idempotency-Key header (responses are stored for replay; reusing a key with a different request returns 409 IDEMPOTENCY_CONFLICT). Rate tier: write.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Presolve Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://grand-charter.mintlify.site/docs/_mintlify/api/og/v2?division=Settlement+Funds\u0026amp;title=Record+an+inbound+check\u0026amp;description=Supports+one+selected+organization+via+%60organizationId%60.+Omit+it+to+use+the+key%27s+organization.+HQ+descendant+access+requires+an+active+acting+attorney+with+%60hq\u0026amp;theme=38b60eada00d734a353ffc01\u0026amp;signature=4b6ead33d45e072bb9f5d7407f496a4d5aef3a69aacf83a202a1cd2230443d2e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Record an inbound check - Presolve Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Supports one selected organization via organizationId. Omit it to use the key\u0026#x27;s organization. HQ descendant access requires an active acting attorney with hq:view_child_orgs, cases:view, cases:view_all, hq:view_all_cases, accounting:view, accounting:view_all, hq:view_all_accounting, settlements:view, disbursements:view, hq:manage_child_orgs, accounting:process_payments, settlements:edit. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See HQ authorization. Requires the funds:write scope. Mutations require an X-Idempotency-Key header (responses are stored for replay; reusing a key with a different request returns 409 IDEMPOTENCY_CONFLICT). Rate tier: write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://grand-charter.mintlify.site/docs/_mintlify/api/og/v2?division=Settlement+Funds\u0026amp;title=Record+an+inbound+check\u0026amp;description=Supports+one+selected+organization+via+%60organizationId%60.+Omit+it+to+use+the+key%27s+organization.+HQ+descendant+access+requires+an+active+acting+attorney+with+%60hq\u0026amp;theme=38b60eada00d734a353ffc01\u0026amp;signature=4b6ead33d45e072bb9f5d7407f496a4d5aef3a69aacf83a202a1cd2230443d2e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/grand-charter/PwZqexm48nOhpZH5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Presolve Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#334E68\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/settlement-funds/record-an-inbound-check.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.presolve.com/#organization\",\"name\":\"Presolve Documentation\",\"url\":\"https://www.presolve.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/grand-charter/kgY2Gushfw80fPEZ/images/presolve-logo-light.svg?fit=max\u0026auto=format\u0026n=kgY2Gushfw80fPEZ\u0026q=85\u0026s=e9ba70b57f4e3c87a6dc5c3dce12cdec\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.presolve.com/docs#website\",\"name\":\"Presolve Documentation\",\"url\":\"https://www.presolve.com/docs\",\"publisher\":{\"@id\":\"https://www.presolve.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check#webpage\",\"url\":\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check\",\"name\":\"Record an inbound check\",\"description\":\"Supports one selected organization via organizationId. Omit it to use the key's organization. HQ descendant access requires an active acting attorney with hq:view_child_orgs, cases:view, cases:view_all, hq:view_all_cases, accounting:view, accounting:view_all, hq:view_all_accounting, settlements:view, disbursements:view, hq:manage_child_orgs, accounting:process_payments, settlements:edit. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See HQ authorization. Requires the funds:write scope. Mutations require an X-Idempotency-Key header (responses are stored for replay; reusing a key with a different request returns 409 IDEMPOTENCY_CONFLICT). Rate tier: write.\",\"dateModified\":\"2026-11-06T19:49:56.055Z\",\"isPartOf\":{\"@id\":\"https://www.presolve.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Settlement Funds\",\"item\":\"https://www.presolve.com/docs/api-reference/settlement-funds/list-resolutions-for-a-case\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Record an inbound check\",\"item\":\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check#apireference\",\"headline\":\"Record an inbound check\",\"name\":\"Record an inbound check\",\"description\":\"Supports one selected organization via organizationId. Omit it to use the key's organization. HQ descendant access requires an active acting attorney with hq:view_child_orgs, cases:view, cases:view_all, hq:view_all_cases, accounting:view, accounting:view_all, hq:view_all_accounting, settlements:view, disbursements:view, hq:manage_child_orgs, accounting:process_payments, settlements:edit. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. Mutation key scopes, idempotency, revisions, and resource-specific eligibility still apply. See HQ authorization. Requires the funds:write scope. Mutations require an X-Idempotency-Key header (responses are stored for replay; reusing a key with a different request returns 409 IDEMPOTENCY_CONFLICT). Rate tier: write.\",\"url\":\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check\",\"mainEntityOfPage\":{\"@id\":\"https://www.presolve.com/docs/api-reference/settlement-funds/record-an-inbound-check#webpage\"},\"dateModified\":\"2026-11-06T19:49:56.055Z\",\"publisher\":{\"@id\":\"https://www.presolve.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.presolve.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Presolve Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Presolve Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/settlement-funds/record-an-inbound-check.md","siteName":"Presolve Documentation","nav":{"global":null,"tabs":[{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help"}]},{"tab":"What's new","pages":[{"title":"What's new","href":"/changelog"}]},{"tab":"Developer Guides","pages":[{"title":"Developer Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Platform","pages":[{"title":"Describe the calling service account","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/me","href":"/api-reference/platform/describe-the-calling-service-account"}]},{"group":"Org \u0026 Team","pages":[{"title":"Get the organization profile","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/organization","href":"/api-reference/org-\u0026-team/get-the-organization-profile"},{"title":"List organization members","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/members","href":"/api-reference/org-\u0026-team/list-organization-members"},{"title":"Get member detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/members/{memberId}","href":"/api-reference/org-\u0026-team/get-member-detail"},{"title":"List org roles and permission sets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/roles","href":"/api-reference/org-\u0026-team/list-org-roles-and-permission-sets"},{"title":"List pending member invites","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/member-invites","href":"/api-reference/org-\u0026-team/list-pending-member-invites"},{"title":"Invite a member","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/member-invites","href":"/api-reference/org-\u0026-team/invite-a-member"},{"title":"Rescind a member invite","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/member-invites/{inviteId}","href":"/api-reference/org-\u0026-team/rescind-a-member-invite"},{"title":"List the org’s service accounts (integration keys)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/service-accounts","href":"/api-reference/org-\u0026-team/list-the-org’s-service-accounts-integration-keys"},{"title":"Create a service account","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/service-accounts","href":"/api-reference/org-\u0026-team/create-a-service-account"},{"title":"Revoke a service account","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/service-accounts/{keyId}","href":"/api-reference/org-\u0026-team/revoke-a-service-account"},{"title":"Reconfigure a service account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/service-accounts/{keyId}","href":"/api-reference/org-\u0026-team/reconfigure-a-service-account"}]},{"group":"Cases","pages":[{"title":"List / search cases","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases","href":"/api-reference/cases/list-search-cases"},{"title":"Create a case","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases","href":"/api-reference/cases/create-a-case"},{"title":"Get case detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}","href":"/api-reference/cases/get-case-detail"},{"title":"Archive (soft-delete) a case","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/cases/{caseId}","href":"/api-reference/cases/archive-soft-delete-a-case"},{"title":"Update mutable case fields","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/cases/{caseId}","href":"/api-reference/cases/update-mutable-case-fields"},{"title":"Restore an archived case","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/restore","href":"/api-reference/cases/restore-an-archived-case"},{"title":"Request a case turn-down","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/turndown-requests","href":"/api-reference/cases/request-a-case-turn-down"},{"title":"Cancel a pending turn-down","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/cases/{caseId}/turndown-requests","href":"/api-reference/cases/cancel-a-pending-turn-down"},{"title":"List case history entries","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/history","href":"/api-reference/cases/list-case-history-entries"},{"title":"List case tags","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/tags","href":"/api-reference/cases/list-case-tags"},{"title":"Add a case tag","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/cases/{caseId}/tags/{tag}","href":"/api-reference/cases/add-a-case-tag"},{"title":"Remove a case tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/cases/{caseId}/tags/{tag}","href":"/api-reference/cases/remove-a-case-tag"},{"title":"List case attorneys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/attorneys","href":"/api-reference/cases/list-case-attorneys"},{"title":"Change the primary attorney","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/cases/{caseId}/primary-attorney","href":"/api-reference/cases/change-the-primary-attorney"},{"title":"Add / update a secondary attorney","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/cases/{caseId}/attorneys/{attorneyId}","href":"/api-reference/cases/add-update-a-secondary-attorney"},{"title":"Remove a secondary attorney","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/cases/{caseId}/attorneys/{attorneyId}","href":"/api-reference/cases/remove-a-secondary-attorney"}]},{"group":"Leads","pages":[{"title":"List pending intake reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/leads/intake-reviews","href":"/api-reference/leads/list-pending-intake-reviews"},{"title":"List / filter leads","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/leads","href":"/api-reference/leads/list-filter-leads"},{"title":"Create a lead","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/leads","href":"/api-reference/leads/create-a-lead"},{"title":"Get lead detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/leads/{leadId}","href":"/api-reference/leads/get-lead-detail"},{"title":"Update a lead","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/leads/{leadId}","href":"/api-reference/leads/update-a-lead"},{"title":"List lead status history","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/leads/{leadId}/history","href":"/api-reference/leads/list-lead-status-history"},{"title":"Transition lead status (guarded)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/leads/{leadId}/transitions","href":"/api-reference/leads/transition-lead-status-guarded"},{"title":"Cancel a pending lead turn-down","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/leads/{leadId}/turndown-requests","href":"/api-reference/leads/cancel-a-pending-lead-turn-down"},{"title":"List the org’s lead sub-status definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/lead-statuses","href":"/api-reference/leads/list-the-org’s-lead-sub-status-definitions"},{"title":"List the org’s turn-down reasons","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/turndown-reasons","href":"/api-reference/leads/list-the-org’s-turn-down-reasons"}]},{"group":"Clients","pages":[{"title":"List / search clients","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients","href":"/api-reference/clients/list-search-clients"},{"title":"Create a standalone client","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients","href":"/api-reference/clients/create-a-standalone-client"},{"title":"Get client detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients/{clientId}","href":"/api-reference/clients/get-client-detail"},{"title":"Update a client","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/clients/{clientId}","href":"/api-reference/clients/update-a-client"},{"title":"List cases for a client","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients/{clientId}/cases","href":"/api-reference/clients/list-cases-for-a-client"},{"title":"List client relationships","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients/{clientId}/relationships","href":"/api-reference/clients/list-client-relationships"}]},{"group":"Contacts","pages":[{"title":"List / search contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contacts","href":"/api-reference/contacts/list-search-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get contact detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contacts/{contactId}","href":"/api-reference/contacts/get-contact-detail"},{"title":"Soft-delete a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/contacts/{contactId}","href":"/api-reference/contacts/soft-delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/contacts/{contactId}","href":"/api-reference/contacts/update-a-contact"},{"title":"List cases a contact is assigned to","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contacts/{contactId}/cases","href":"/api-reference/contacts/list-cases-a-contact-is-assigned-to"},{"title":"List contacts on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/contacts","href":"/api-reference/contacts/list-contacts-on-a-case"},{"title":"Assign a contact to a case","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/cases/{caseId}/contacts/{contactId}","href":"/api-reference/contacts/assign-a-contact-to-a-case"},{"title":"Unassign a contact from a case","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/cases/{caseId}/contacts/{contactId}","href":"/api-reference/contacts/unassign-a-contact-from-a-case"},{"title":"List contact assignment types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contact-assignment-types","href":"/api-reference/contacts/list-contact-assignment-types"}]},{"group":"Documents","pages":[{"title":"List / filter documents org-wide","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents","href":"/api-reference/documents/list-filter-documents-org-wide"},{"title":"Merged folder + document snapshot for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/document-items","href":"/api-reference/documents/merged-folder-+-document-snapshot-for-a-case"},{"title":"Get document metadata","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents/{documentId}","href":"/api-reference/documents/get-document-metadata"},{"title":"Soft-delete a document","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/documents/{documentId}","href":"/api-reference/documents/soft-delete-a-document"},{"title":"Rename / move a document","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/documents/{documentId}","href":"/api-reference/documents/rename-move-a-document"},{"title":"Restore a soft-deleted document","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/documents/{documentId}/restore","href":"/api-reference/documents/restore-a-soft-deleted-document"},{"title":"Download document content","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents/{documentId}/content","href":"/api-reference/documents/download-document-content"},{"title":"List document versions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents/{documentId}/versions","href":"/api-reference/documents/list-document-versions"},{"title":"Download a prior version","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents/{documentId}/versions/{versionId}/content","href":"/api-reference/documents/download-a-prior-version"},{"title":"List document tags","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents/{documentId}/tags","href":"/api-reference/documents/list-document-tags"},{"title":"Add a document tag","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/documents/{documentId}/tags/{tag}","href":"/api-reference/documents/add-a-document-tag"},{"title":"Remove a document tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/documents/{documentId}/tags/{tag}","href":"/api-reference/documents/remove-a-document-tag"},{"title":"Batch-move documents / folders","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/documents/batch/move","href":"/api-reference/documents/batch-move-documents-folders"},{"title":"Batch-copy documents","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/documents/batch/copy","href":"/api-reference/documents/batch-copy-documents"},{"title":"Batch soft-delete documents","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/documents/batch/delete","href":"/api-reference/documents/batch-soft-delete-documents"},{"title":"Move a document to another case","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/documents/{documentId}/move-to-case","href":"/api-reference/documents/move-a-document-to-another-case"},{"title":"Get the full folder hierarchy for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/folder-tree","href":"/api-reference/documents/get-the-full-folder-hierarchy-for-a-case"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/folders","href":"/api-reference/documents/create-a-folder"},{"title":"Soft-delete a folder","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/folders/{folderId}","href":"/api-reference/documents/soft-delete-a-folder"},{"title":"Rename / move a folder","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/folders/{folderId}","href":"/api-reference/documents/rename-move-a-folder"},{"title":"Restore a soft-deleted folder","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/folders/{folderId}/restore","href":"/api-reference/documents/restore-a-soft-deleted-folder"},{"title":"Mint a presigned upload session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/document-uploads","href":"/api-reference/documents/mint-a-presigned-upload-session"},{"title":"Commit a presigned upload","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/document-uploads/{uploadId}/complete","href":"/api-reference/documents/commit-a-presigned-upload"},{"title":"List share links","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/share-links","href":"/api-reference/documents/list-share-links"},{"title":"Create a share link","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/share-links","href":"/api-reference/documents/create-a-share-link"},{"title":"Revoke a share link","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/share-links/{linkId}","href":"/api-reference/documents/revoke-a-share-link"}]},{"group":"Notes","pages":[{"title":"List notes on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/notes","href":"/api-reference/notes/list-notes-on-a-case"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/notes","href":"/api-reference/notes/create-a-note"},{"title":"Get note detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/notes/{noteId}","href":"/api-reference/notes/get-note-detail"},{"title":"Soft-delete a note","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/notes/{noteId}","href":"/api-reference/notes/soft-delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/notes/{noteId}","href":"/api-reference/notes/update-a-note"}]},{"group":"Tasks","pages":[{"title":"List tasks org-wide","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/tasks","href":"/api-reference/tasks/list-tasks-org-wide"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"List tasks on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/tasks","href":"/api-reference/tasks/list-tasks-on-a-case"},{"title":"Get task detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/tasks/{taskId}","href":"/api-reference/tasks/get-task-detail"},{"title":"Cancel a task","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/tasks/{taskId}","href":"/api-reference/tasks/cancel-a-task"},{"title":"Update task fields","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/tasks/{taskId}","href":"/api-reference/tasks/update-task-fields"},{"title":"Complete a task","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tasks/{taskId}/complete","href":"/api-reference/tasks/complete-a-task"},{"title":"Reopen a completed task","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tasks/{taskId}/uncomplete","href":"/api-reference/tasks/reopen-a-completed-task"},{"title":"Snooze a task to a new due date","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tasks/{taskId}/snooze","href":"/api-reference/tasks/snooze-a-task-to-a-new-due-date"},{"title":"Assign a user to a task","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/tasks/{taskId}/assignees/{userId}","href":"/api-reference/tasks/assign-a-user-to-a-task"},{"title":"Unassign a user from a task","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/tasks/{taskId}/assignees/{userId}","href":"/api-reference/tasks/unassign-a-user-from-a-task"},{"title":"Add a task follower","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/tasks/{taskId}/followers/{userId}","href":"/api-reference/tasks/add-a-task-follower"},{"title":"Remove a task follower","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/tasks/{taskId}/followers/{userId}","href":"/api-reference/tasks/remove-a-task-follower"}]},{"group":"Calendar","pages":[{"title":"List calendar items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/calendar-items","href":"/api-reference/calendar/list-calendar-items"},{"title":"Create a calendar item","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/calendar-items","href":"/api-reference/calendar/create-a-calendar-item"},{"title":"List calendar items on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/calendar-items","href":"/api-reference/calendar/list-calendar-items-on-a-case"},{"title":"Get calendar item detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/calendar-items/{itemId}","href":"/api-reference/calendar/get-calendar-item-detail"},{"title":"Cancel a calendar item","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/calendar-items/{itemId}","href":"/api-reference/calendar/cancel-a-calendar-item"},{"title":"Update a calendar item","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/calendar-items/{itemId}","href":"/api-reference/calendar/update-a-calendar-item"}]},{"group":"Deadlines","pages":[{"title":"List deadline obligations for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/deadlines","href":"/api-reference/deadlines/list-deadline-obligations-for-a-case"},{"title":"Create a manual deadline","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/deadlines","href":"/api-reference/deadlines/create-a-manual-deadline"},{"title":"Get deadline detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/deadlines/{deadlineId}","href":"/api-reference/deadlines/get-deadline-detail"},{"title":"Remove a manual deadline","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/deadlines/{deadlineId}","href":"/api-reference/deadlines/remove-a-manual-deadline"},{"title":"Update a deadline","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/deadlines/{deadlineId}","href":"/api-reference/deadlines/update-a-deadline"},{"title":"List the org’s deadline rule packs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/deadline-rule-packs","href":"/api-reference/deadlines/list-the-org’s-deadline-rule-packs"},{"title":"List anchor records for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/anchors","href":"/api-reference/deadlines/list-anchor-records-for-a-case"},{"title":"Set / update an anchor date","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/cases/{caseId}/anchors/{anchorKey}","href":"/api-reference/deadlines/set-update-an-anchor-date"}]},{"group":"Intake","pages":[{"title":"List intake answers for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/survey-details","href":"/api-reference/intake/list-intake-answers-for-a-case"},{"title":"Bulk-append intake answers","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/survey-details","href":"/api-reference/intake/bulk-append-intake-answers"},{"title":"Get one intake answer","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/survey-details/{accessor}","href":"/api-reference/intake/get-one-intake-answer"},{"title":"Upsert one intake answer","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/cases/{caseId}/survey-details/{accessor}","href":"/api-reference/intake/upsert-one-intake-answer"},{"title":"Soft-delete an intake answer","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/cases/{caseId}/survey-details/{accessor}","href":"/api-reference/intake/soft-delete-an-intake-answer"},{"title":"List the org’s intake question sets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/intake-question-sets","href":"/api-reference/intake/list-the-org’s-intake-question-sets"},{"title":"Get a full question set","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/intake-question-sets/{setId}","href":"/api-reference/intake/get-a-full-question-set"},{"title":"List the org’s case types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/case-types","href":"/api-reference/intake/list-the-org’s-case-types"},{"title":"Get the resolved field schema for a case type","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/case-types/{caseTypeId}/schema","href":"/api-reference/intake/get-the-resolved-field-schema-for-a-case-type"},{"title":"Read case fields as a schema-shaped snapshot","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/fields","href":"/api-reference/intake/read-case-fields-as-a-schema-shaped-snapshot"},{"title":"Write case fields, validated against the schema","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/cases/{caseId}/fields","href":"/api-reference/intake/write-case-fields-validated-against-the-schema"}]},{"group":"E-Sign","pages":[{"title":"List e-sign documents on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/esign-documents","href":"/api-reference/e-sign/list-e-sign-documents-on-a-case"},{"title":"Create and send an e-sign document from a template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/esign-documents","href":"/api-reference/e-sign/create-and-send-an-e-sign-document-from-a-template"},{"title":"Get e-sign document detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/esign-documents/{esignId}","href":"/api-reference/e-sign/get-e-sign-document-detail"},{"title":"Send a manual signing reminder","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/esign-documents/{esignId}/remind","href":"/api-reference/e-sign/send-a-manual-signing-reminder"},{"title":"Void an e-sign envelope","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/esign-documents/{esignId}/cancel","href":"/api-reference/e-sign/void-an-e-sign-envelope"},{"title":"Download the executed document","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/esign-documents/{esignId}/download","href":"/api-reference/e-sign/download-the-executed-document"},{"title":"List the org’s e-sign templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/esign-templates","href":"/api-reference/e-sign/list-the-org’s-e-sign-templates"}]},{"group":"Billing","pages":[{"title":"List liens on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/liens","href":"/api-reference/billing/list-liens-on-a-case"},{"title":"Create a lien","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/liens","href":"/api-reference/billing/create-a-lien"},{"title":"Get lien detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/liens/{lienId}","href":"/api-reference/billing/get-lien-detail"},{"title":"Soft-delete a lien","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/liens/{lienId}","href":"/api-reference/billing/soft-delete-a-lien"},{"title":"Update a lien","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/liens/{lienId}","href":"/api-reference/billing/update-a-lien"},{"title":"List expenses on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/expenses","href":"/api-reference/billing/list-expenses-on-a-case"},{"title":"Create an expense","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/expenses","href":"/api-reference/billing/create-an-expense"},{"title":"Get expense detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/expenses/{expenseId}","href":"/api-reference/billing/get-expense-detail"},{"title":"Soft-delete an expense","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/expenses/{expenseId}","href":"/api-reference/billing/soft-delete-an-expense"},{"title":"Update an expense","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/expenses/{expenseId}","href":"/api-reference/billing/update-an-expense"},{"title":"List time entries","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/time-entries","href":"/api-reference/billing/list-time-entries"},{"title":"Create a time entry","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/time-entries","href":"/api-reference/billing/create-a-time-entry"},{"title":"Get time entry detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/time-entries/{entryId}","href":"/api-reference/billing/get-time-entry-detail"},{"title":"Delete a time entry","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/time-entries/{entryId}","href":"/api-reference/billing/delete-a-time-entry"},{"title":"Update a time entry","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/time-entries/{entryId}","href":"/api-reference/billing/update-a-time-entry"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/invoices","href":"/api-reference/billing/list-invoices"},{"title":"Get invoice detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/invoices/{invoiceId}","href":"/api-reference/billing/get-invoice-detail"},{"title":"Edit a draft invoice","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/invoices/{invoiceId}","href":"/api-reference/billing/edit-a-draft-invoice"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/invoices","href":"/api-reference/billing/create-an-invoice"},{"title":"Transition invoice status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/invoices/{invoiceId}/transitions","href":"/api-reference/billing/transition-invoice-status"},{"title":"Download the uploaded invoice file","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/invoices/{invoiceId}/document","href":"/api-reference/billing/download-the-uploaded-invoice-file"}]},{"group":"Settlement Funds","pages":[{"title":"List resolutions for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/resolutions","href":"/api-reference/settlement-funds/list-resolutions-for-a-case"},{"title":"Get resolution detail with ledger summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/resolutions/{resolutionId}","href":"/api-reference/settlement-funds/get-resolution-detail-with-ledger-summary"},{"title":"Preview the settlement allocation waterfall","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/resolutions/{resolutionId}/allocation-previews","href":"/api-reference/settlement-funds/preview-the-settlement-allocation-waterfall"},{"title":"List checks on a case","description":"Supports one selected organization via `organizationId`. Omit it to use the key's organization. HQ descendant access requires an active acting attorney with `hq:view_child_orgs`, `cases:view`, `cases:view_all`, `hq:view_all_cases`, `accounting:view`, `accounting:view_all`, `hq:view_all_accounting`, `settlements:view`, `disbursements:view`. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. See [HQ authorization](/authorization).\n\nRequires the `funds:read` scope. Rate tier: `read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/checks","href":"/api-reference/settlement-funds/list-checks-on-a-case"},{"title":"Record an inbound check","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/checks","href":"/api-reference/settlement-funds/record-an-inbound-check"},{"title":"Get check detail with allocations","description":"Supports one selected organization via `organizationId`. Omit it to use the key's organization. HQ descendant access requires an active acting attorney with `hq:view_child_orgs`, `cases:view`, `cases:view_all`, `hq:view_all_cases`, `accounting:view`, `accounting:view_all`, `hq:view_all_accounting`, `settlements:view`, `disbursements:view`. Existing key scopes still apply. The selector requires an integration API key; legacy partner/OIDC routing is unchanged. Repeat the selector on every cursor page, related mutation, upload completion, and detail/download request. See [HQ authorization](/authorization).\n\nRequires the `funds:read` scope. Rate tier: `read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/checks/{checkId}","href":"/api-reference/settlement-funds/get-check-detail-with-allocations"},{"title":"Update check metadata","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/checks/{checkId}","href":"/api-reference/settlement-funds/update-check-metadata"},{"title":"Transition check status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checks/{checkId}/transitions","href":"/api-reference/settlement-funds/transition-check-status"},{"title":"List a check’s allocation lines","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/checks/{checkId}/allocations","href":"/api-reference/settlement-funds/list-a-check’s-allocation-lines"},{"title":"Get available funds for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/available-funds","href":"/api-reference/settlement-funds/get-available-funds-for-a-case"},{"title":"List disbursements on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/disbursements","href":"/api-reference/settlement-funds/list-disbursements-on-a-case"},{"title":"List disbursements org-wide","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/disbursements","href":"/api-reference/settlement-funds/list-disbursements-org-wide"},{"title":"Get disbursement detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/disbursements/{disbursementId}","href":"/api-reference/settlement-funds/get-disbursement-detail"},{"title":"Transition disbursement status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/disbursements/{disbursementId}/transitions","href":"/api-reference/settlement-funds/transition-disbursement-status"}]},{"group":"Referrals","pages":[{"title":"List referrals","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/referrals","href":"/api-reference/referrals/list-referrals"},{"title":"Get referral detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/referrals/{referralId}","href":"/api-reference/referrals/get-referral-detail"},{"title":"Create an outbound referral","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/referrals","href":"/api-reference/referrals/create-an-outbound-referral"},{"title":"Accept a referral","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/referrals/{referralId}/accept","href":"/api-reference/referrals/accept-a-referral"},{"title":"Decline a referral","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/referrals/{referralId}/decline","href":"/api-reference/referrals/decline-a-referral"},{"title":"List referral activities","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/referrals/{referralId}/activities","href":"/api-reference/referrals/list-referral-activities"}]},{"group":"Communications","pages":[{"title":"List logged emails on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/emails","href":"/api-reference/communications/list-logged-emails-on-a-case"},{"title":"Append an email record to a case","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/emails","href":"/api-reference/communications/append-an-email-record-to-a-case"},{"title":"Get a logged email","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/emails/{emailId}","href":"/api-reference/communications/get-a-logged-email"},{"title":"List call logs on a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/call-logs","href":"/api-reference/communications/list-call-logs-on-a-case"},{"title":"Append a call record to a case","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/call-logs","href":"/api-reference/communications/append-a-call-record-to-a-case"},{"title":"Get a call log entry","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/call-logs/{callLogId}","href":"/api-reference/communications/get-a-call-log-entry"}]},{"group":"Medical","pages":[{"title":"List medical facilities bound to a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/medical-facilities","href":"/api-reference/medical/list-medical-facilities-bound-to-a-case"},{"title":"Bind a contact as a medical facility","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/medical-facilities","href":"/api-reference/medical/bind-a-contact-as-a-medical-facility"},{"title":"Soft-delete a facility binding","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/medical-facilities/{facilityId}","href":"/api-reference/medical/soft-delete-a-facility-binding"},{"title":"Update facility routing config","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/medical-facilities/{facilityId}","href":"/api-reference/medical/update-facility-routing-config"},{"title":"List treatment summaries for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/treatment-summaries","href":"/api-reference/medical/list-treatment-summaries-for-a-case"},{"title":"Create a treatment summary","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/treatment-summaries","href":"/api-reference/medical/create-a-treatment-summary"},{"title":"Update a treatment summary","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/treatment-summaries/{summaryId}","href":"/api-reference/medical/update-a-treatment-summary"},{"title":"List records-retrieval requests for a case","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/cases/{caseId}/retrieval-requests","href":"/api-reference/medical/list-records-retrieval-requests-for-a-case"},{"title":"Create a retrieval request","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/cases/{caseId}/retrieval-requests","href":"/api-reference/medical/create-a-retrieval-request"},{"title":"Get retrieval request detail","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/retrieval-requests/{requestId}","href":"/api-reference/medical/get-retrieval-request-detail"},{"title":"Cancel a retrieval request","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/retrieval-requests/{requestId}/cancel","href":"/api-reference/medical/cancel-a-retrieval-request"},{"title":"Download received records / bills","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/retrieval-requests/{requestId}/documents/{docId}/content","href":"/api-reference/medical/download-received-records-bills"}]},{"group":"Reports \u0026 Exports","pages":[{"title":"List API-visible saved reports","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reports","href":"/api-reference/reports-\u0026-exports/list-api-visible-saved-reports"},{"title":"Get report definition metadata","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reports/{reportId}","href":"/api-reference/reports-\u0026-exports/get-report-definition-metadata"},{"title":"Execute a saved report","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/reports/{reportId}/run","href":"/api-reference/reports-\u0026-exports/execute-a-saved-report"},{"title":"List export jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/export-jobs","href":"/api-reference/reports-\u0026-exports/list-export-jobs"},{"title":"Enqueue a bulk data export","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/export-jobs","href":"/api-reference/reports-\u0026-exports/enqueue-a-bulk-data-export"},{"title":"Get export job status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/export-jobs/{jobId}","href":"/api-reference/reports-\u0026-exports/get-export-job-status"},{"title":"Download a completed export","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/export-jobs/{jobId}/download","href":"/api-reference/reports-\u0026-exports/download-a-completed-export"}]},{"group":"Events \u0026 Webhooks","pages":[{"title":"Read the unified event feed","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/events","href":"/api-reference/events-\u0026-webhooks/read-the-unified-event-feed"},{"title":"Read the documents-only event feed (legacy alias)","deprecated":true,"version":null,"openapi":"/openapi.json get /api/v1/document-events","href":"/api-reference/events-\u0026-webhooks/read-the-documents-only-event-feed-legacy-alias"},{"title":"Enumerate subscribable event types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhook-events","href":"/api-reference/events-\u0026-webhooks/enumerate-subscribable-event-types"},{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhook-subscriptions","href":"/api-reference/events-\u0026-webhooks/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhook-subscriptions","href":"/api-reference/events-\u0026-webhooks/create-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/webhook-subscriptions/{subscriptionId}","href":"/api-reference/events-\u0026-webhooks/delete-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/webhook-subscriptions/{subscriptionId}","href":"/api-reference/events-\u0026-webhooks/update-a-webhook-subscription"}]}]}]},"basePath":"","title":"Record an inbound check - Presolve Documentation","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}