{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
Settlements
Create settlement
Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
{
"code": "forbidden",
"message": "You do not have access to this organization.",
"error": "You do not have access to this organization.",
"details": {
"fields": [
{
"field": "amount",
"code": "invalid_type"
}
]
}
}
Authorizations
ApiKeyAuthGrainOAuth2BearerAuth
Authorization
string
header
required
Organization API key created in Grain Settings → API. The key determines the organization and is limited to its assigned resource scopes. Write scopes imply the corresponding read scope.
Headers
X-Organization-Id
string
Required with OAuth access tokens for resource requests. Omit only for GET /api/v1/organizations. Optional with organization API keys; if supplied with an API key, it must match the key's organization.
Body
application/json
estimatedArrivalDate
string<date>
required
totalGross
number
required
Required range: x >= 0
totalFees
number
required
Required range: x >= 0
totalNet
number
required
Required range: x >= 0
paymentCount
integer
required
Required range: x >= 0
provider
enum<string>
default:MANUAL
Available options:
STRIPE,
PUSHPAY,
SUBSPLASH,
TITHELY,
PLANNING_CENTER,
ROCK_RMS,
RAMP,
DIVVY,
OVERFLOW,
MANUAL
externalId
string
Generated when omitted for a manual settlement.
externalReference
string | null
actualArrivalDate
string<date> | null
currency
string
default:USD
Required string length: 3
settlementType
string | null
status
enum<string>
Available options:
PENDING,
IN_TRANSIT,
DEPOSITED,
FAILED,
CANCELLED
errorMessage
string | null
failureCode
string | null
depositBasis
enum<string> | null
Available options:
GROSS,
NET
givingIntegrationId
string | null
givingMerchantId
string | null
contributionIds
string[]
Maximum array length: 10000
givingBatchIds
string[]
Maximum array length: 10000
dimensions
object[]
Maximum array length: 100
Hide child attributes
dimensions.dimensionId
string
required
Minimum string length: 1
dimensions.dimensionValueId
string
required
Minimum string length: 1
Response
Created settlement
Recorded settlement values plus independently calculated linked-contribution totals. Accounting and bank-link state are read-only; raw provider metadata, sync diagnostics, accounting details, and fingerprints are excluded.
id
string
required
provider
enum<string>
required
Available options:
STRIPE,
PUSHPAY,
SUBSPLASH,
TITHELY,
PLANNING_CENTER,
ROCK_RMS,
RAMP,
DIVVY,
OVERFLOW,
MANUAL
externalId
string
required
estimatedArrivalDate
string<date-time>
required
Calendar day represented as a UTC-midnight ISO timestamp.
recordedTotals
object
required
Hide child attributes
recordedTotals.gross
number
recordedTotals.fees
number
recordedTotals.net
number
recordedTotals.paymentCount
integer
recordedTotals.donationCount
integer
linkedContributionTotals
object
required
Hide child attributes
linkedContributionTotals.gross
number
linkedContributionTotals.fees
number
linkedContributionTotals.net
number
linkedContributionTotals.paymentCount
integer
linkedContributionTotals.donationCount
integer
currency
string
required
Required string length: 3
status
enum<string>
required
Available options:
PENDING,
IN_TRANSIT,
DEPOSITED,
MATCHED,
RECONCILED,
FAILED,
CANCELLED
accounting
object
required
read-only
Hide child attributes
accounting.disposition
enum<string>
required
Available options:
ELIGIBLE,
NEEDS_REVIEW,
RECORDED_EXTERNALLY
accounting.reason
string | null
required
accounting.journalEntry
object | null
required
Hide child attributes
accounting.journalEntry.id
string
required
accounting.journalEntry.entryNumber
string | null
required
accounting.journalEntry.referenceNumber
string | null
required
bankLink
object
required
read-only
Hide child attributes
bankLink.isLinked
boolean
required
bankLink.transaction
object | null
required
Hide child attributes
bankLink.transaction.id
string
required
bankLink.transaction.date
string<date-time>
required
bankLink.transaction.amount
number
required
bankLink.transaction.description
string
required
isFrozen
boolean
required
read-only
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
externalReference
string | null
actualArrivalDate
string<date-time> | null
Calendar day represented as a UTC-midnight ISO timestamp.
settlementType
string | null
errorMessage
string | null
failureCode
string | null
depositBasis
enum<string> | null
Available options:
GROSS,
NET
givingIntegration
object | null
Hide child attributes
givingIntegration.id
string
required
givingIntegration.provider
string | null
required
givingIntegration.name
string | null
required
merchant
object | null
Hide child attributes
merchant.id
string
required
merchant.name
string
required
merchant.campusId
string | null
required
merchant.dimensionValueId
string | null
required
dimensions
object[]
Hide child attributes
dimensions.dimensionId
string
required
dimensions.dimensionValueId
string
required
dimensions.dimensionName
string | null
read-only
dimensions.dimensionValueName
string | null
read-only
batches
object[]
Hide child attributes
batches.id
string
required
batches.externalReference
string
required
batches.status
string
required
batches.batchDate
string<date-time>
required
batches.totalNet
number
required
Last modified on October 10, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Grain API","description":"Developer documentation for the Grain church accounting and donor management API.","colors":{"primary":"#03440c","light":"#4A806C","dark":"#3D6B5E"},"logo":{"light":"https://mintcdn.com/grainledger/Jxl-ZANCEY95i3PU/images/grain-wordmark-on-light.svg?fit=max\u0026auto=format\u0026n=Jxl-ZANCEY95i3PU\u0026q=85\u0026s=47f8188964661273a33f4901a311ba81","dark":"https://mintcdn.com/grainledger/Jxl-ZANCEY95i3PU/images/grain-wordmark-on-dark.svg?fit=max\u0026auto=format\u0026n=Jxl-ZANCEY95i3PU\u0026q=85\u0026s=b4689fb4f3c2b42f5e3e251f39b0bf76"},"favicon":"https://mintcdn.com/grainledger/Jxl-ZANCEY95i3PU/images/grain-logomark.svg?fit=max\u0026auto=format\u0026n=Jxl-ZANCEY95i3PU\u0026q=85\u0026s=e53c14afdfadd5aa05ef57a0c8f68985","api":{"openapi":["openapi.json"],"params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":true,"autogenerate":true},"url":"full"},"search":{"prompt":"Search Grain API docs..."},"seo":{"metatags":{"og:site_name":"Grain API Docs","og:image":"https://grainledger.com/og-image.jpg?v=wheat-field-20260908","og:image:width":"1200","og:image:height":"630","twitter:card":"summary_large_image","twitter:image":"https://grainledger.com/og-image.jpg?v=wheat-field-20260908"},"indexing":"navigable"},"fonts":{"heading":{"family":"DM Sans","weight":600},"body":{"family":"DM Sans","weight":400}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"integrations":{"posthog":{"apiKey":"phc_nev4txvApsir3qS4dQB5T7JvI46Zl0ZXSQHXpgo6IhD","apiHost":"https://us.i.posthog.com","sessionRecording":false}},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"Open app","icon":"https://mintlify.s3.us-west-1.amazonaws.com/grainledger/images/grain-logomark.svg","href":"https://app.grainledger.com"},{"anchor":"Support","icon":"circle-question","href":"https://grainledger.com/support"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"grainledger","hasAudioNarration":false,"actualSubdomain":"grainledger","customDomains":["docs.grainledger.com"],"gitSource":{"type":"github","owner":"grain-ledger","repo":"grain","deployBranch":"main","contentDirectory":"api-docs","isPrivate":true,"mountPath":"","label":"","_id":"6af23ed0ed34cff0851c7334"},"entitlements":{},"buildId":"6aca5e6adf7fb4ef9ef2ce28","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":59},{"language":"default","tag":"Transactions","count":14},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Households","count":8},{"language":"default","tag":"Core concepts","count":7},{"language":"default","tag":"Bills","count":5},{"language":"default","tag":"Contributions","count":5},{"language":"default","tag":"Donors","count":5},{"language":"default","tag":"Giving Batches","count":5},{"language":"default","tag":"Pledges","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":true},"customCss":[]}
{"page":{"pagePath":"api-reference/settlements/create-settlement","slug":"/api-reference/settlements/create-settlement","pageMetadata":{"title":"Create settlement","description":"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/settlements","href":"/api-reference/settlements/create-settlement","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.\"\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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Create settlement","description":"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/settlements","href":"/api-reference/settlements/create-settlement","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Settlements"],"summary":"Create settlement","description":"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.","parameters":["9ed610aa-b983-442c-93a5-ea4efe3f7c51"],"requestBody":"a6084c13-c355-42c6-a36e-2ca8df326f84","responses":{"201":"d4c3c44d-ebd0-43de-9eaa-9cf57a1b1484","400":"3ada93de-b09f-4365-a376-8f2fe5e03916","401":"3cacc55a-fd48-45c0-8bae-80e02fd760fc","403":"eb86bd42-ac32-414b-9f53-f4d4b533a42c","404":"22af88da-95a2-44a1-9eb4-11a8082161d3","409":"9e8f9921-f1fc-41c7-86e0-771baf4d88a6","422":"82afc889-a9d2-4301-ac9e-f0882ad77159","429":"ca834005-f0ac-4f18-bd0a-69793a114906","500":"70af9f0e-6083-4843-b8b4-0be94a10a461"},"method":"post","type":"path","servers":["f6713c7b-79dc-4516-9fa4-b80a2e5b565a"],"security":["b13aa5d4-77e1-4461-944f-0c8c2480e9b6","0a4ca29a-fd5e-40fa-afd3-39cd795826a4","5d65a984-a73a-4263-a6ec-edd6bb054d60"],"path":"/api/v1/settlements","baseUrlOptions":["https://api.grainledger.com"],"title":"Create settlement","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.estimatedArrivalDate":"2026-08-21","body.totalGross":1025,"body.totalFees":25,"body.totalNet":1000,"body.paymentCount":8,"body.externalReference.oneOf.0":"August online giving","body.contributionIds.items.0":"contribution_1"}],"urlDisplay":"full"},"dependencies":{"parameters":{"9ed610aa-b983-442c-93a5-ea4efe3f7c51":{"name":"X-Organization-Id","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"Required with OAuth access tokens for resource requests. Omit only for GET /api/v1/organizations. Optional with organization API keys; if supplied with an API key, it must match the key's organization.","uniqueKey":"","typeLabel":"string"},"description":"Required with OAuth access tokens for resource requests. Omit only for GET /api/v1/organizations. Optional with organization API keys; if supplied with an API key, it must match the key's organization.","example":"cm123abc456def"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["estimatedArrivalDate","totalGross","totalFees","totalNet","paymentCount"],"properties":{"estimatedArrivalDate":{"type":"string","format":"date","isRequired":true,"uniqueKey":"estimatedArrivalDate","typeLabel":"string\u003cdate>"},"totalGross":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"totalGross","typeLabel":"number"},"totalFees":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"totalFees","typeLabel":"number"},"totalNet":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"totalNet","typeLabel":"number"},"paymentCount":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"paymentCount","typeLabel":"integer"},"provider":{"type":"string","enum":["STRIPE","PUSHPAY","SUBSPLASH","TITHELY","PLANNING_CENTER","ROCK_RMS","RAMP","DIVVY","OVERFLOW","MANUAL"],"default":"MANUAL","uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"externalId":{"type":"string","description":"Generated when omitted for a manual settlement.","uniqueKey":"externalId","typeLabel":"string"},"externalReference":{"oneOf":[{"type":"string","uniqueKey":"externalReference.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"externalReference.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalReference","typeLabel":"string | null"},"actualArrivalDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"actualArrivalDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"actualArrivalDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"actualArrivalDate","typeLabel":"string\u003cdate> | null"},"currency":{"type":"string","minLength":3,"maxLength":3,"default":"USD","uniqueKey":"currency","typeLabel":"string"},"settlementType":{"oneOf":[{"type":"string","uniqueKey":"settlementType.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"settlementType.oneOf.1","typeLabel":"null"}],"uniqueKey":"settlementType","typeLabel":"string | null"},"status":{"type":"string","enum":["PENDING","IN_TRANSIT","DEPOSITED","FAILED","CANCELLED"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"errorMessage","typeLabel":"string | null"},"failureCode":{"oneOf":[{"type":"string","uniqueKey":"failureCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"failureCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"failureCode","typeLabel":"string | null"},"depositBasis":{"oneOf":[{"type":"string","enum":["GROSS","NET"],"uniqueKey":"depositBasis.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["GROSS","NET"],"uniqueKey":"depositBasis.oneOf.1","typeLabel":"null"}],"uniqueKey":"depositBasis","typeLabel":"enum\u003cstring> | null"},"givingIntegrationId":{"oneOf":[{"type":"string","uniqueKey":"givingIntegrationId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"givingIntegrationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"givingIntegrationId","typeLabel":"string | null"},"givingMerchantId":{"oneOf":[{"type":"string","uniqueKey":"givingMerchantId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"givingMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"givingMerchantId","typeLabel":"string | null"},"contributionIds":{"type":"array","maxItems":10000,"items":{"type":"string","uniqueKey":"contributionIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"contributionIds","typeLabel":"string[]"},"givingBatchIds":{"type":"array","maxItems":10000,"items":{"type":"string","uniqueKey":"givingBatchIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"givingBatchIds","typeLabel":"string[]"},"dimensions":{"type":"array","maxItems":100,"items":{"type":"object","additionalProperties":false,"required":["dimensionId","dimensionValueId"],"properties":{"dimensionId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"dimensions.items.[INDEX].dimensionId","typeLabel":"string"},"dimensionValueId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"dimensions.items.[INDEX].dimensionValueId","typeLabel":"string"}},"uniqueKey":"dimensions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"dimensions","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"externalReference":"August online giving","estimatedArrivalDate":"2026-08-21","totalGross":1025,"totalFees":25,"totalNet":1000,"paymentCount":8,"contributionIds":["contribution_1"]},"examples":{"Example":{"title":"Example","value":{"externalReference":"August online giving","estimatedArrivalDate":"2026-08-21","totalGross":1025,"totalFees":25,"totalNet":1000,"paymentCount":8,"contributionIds":["contribution_1"]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"d4c3c44d-ebd0-43de-9eaa-9cf57a1b1484":{"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"description":"Created settlement","content":{"application/json":{"schema":{"type":"object","description":"Recorded settlement values plus independently calculated linked-contribution totals. Accounting and bank-link state are read-only; raw provider metadata, sync diagnostics, accounting details, and fingerprints are excluded.","required":["id","provider","externalId","estimatedArrivalDate","recordedTotals","linkedContributionTotals","currency","status","accounting","bankLink","isFrozen","createdAt","updatedAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"provider":{"type":"string","enum":["STRIPE","PUSHPAY","SUBSPLASH","TITHELY","PLANNING_CENTER","ROCK_RMS","RAMP","DIVVY","OVERFLOW","MANUAL"],"isRequired":true,"uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"externalId":{"type":"string","isRequired":true,"uniqueKey":"externalId","typeLabel":"string"},"estimatedArrivalDate":{"type":"string","format":"date-time","description":"Calendar day represented as a UTC-midnight ISO timestamp.","isRequired":true,"uniqueKey":"estimatedArrivalDate","typeLabel":"string\u003cdate-time>"},"recordedTotals":{"type":"object","properties":{"gross":{"type":"number","uniqueKey":"recordedTotals.gross","typeLabel":"number"},"fees":{"type":"number","uniqueKey":"recordedTotals.fees","typeLabel":"number"},"net":{"type":"number","uniqueKey":"recordedTotals.net","typeLabel":"number"},"paymentCount":{"type":"integer","uniqueKey":"recordedTotals.paymentCount","typeLabel":"integer"},"donationCount":{"type":"integer","uniqueKey":"recordedTotals.donationCount","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"recordedTotals","typeLabel":"object"},"linkedContributionTotals":{"type":"object","properties":{"gross":{"type":"number","uniqueKey":"linkedContributionTotals.gross","typeLabel":"number"},"fees":{"type":"number","uniqueKey":"linkedContributionTotals.fees","typeLabel":"number"},"net":{"type":"number","uniqueKey":"linkedContributionTotals.net","typeLabel":"number"},"paymentCount":{"type":"integer","uniqueKey":"linkedContributionTotals.paymentCount","typeLabel":"integer"},"donationCount":{"type":"integer","uniqueKey":"linkedContributionTotals.donationCount","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"linkedContributionTotals","typeLabel":"object"},"currency":{"type":"string","minLength":3,"maxLength":3,"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"status":{"type":"string","enum":["PENDING","IN_TRANSIT","DEPOSITED","MATCHED","RECONCILED","FAILED","CANCELLED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"accounting":{"type":"object","additionalProperties":false,"readOnly":true,"required":["disposition","reason","journalEntry"],"properties":{"disposition":{"type":"string","enum":["ELIGIBLE","NEEDS_REVIEW","RECORDED_EXTERNALLY"],"isRequired":true,"uniqueKey":"accounting.disposition","typeLabel":"enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"accounting.reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"accounting.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accounting.reason","typeLabel":"string | null"},"journalEntry":{"oneOf":[{"type":"object","additionalProperties":false,"required":["id","entryNumber","referenceNumber"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.0.id","typeLabel":"string"},"entryNumber":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.0.entryNumber.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.0.entryNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.0.entryNumber","typeLabel":"string | null"},"referenceNumber":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.0.referenceNumber.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.0.referenceNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.0.referenceNumber","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["id","entryNumber","referenceNumber"],"properties":{"id":{"type":"string"},"entryNumber":{"oneOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"oneOf":[{"type":"string"},{"type":"null"}]}},"isRequired":true,"uniqueKey":"accounting.journalEntry.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accounting.journalEntry","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"accounting","typeLabel":"object"},"bankLink":{"type":"object","additionalProperties":false,"readOnly":true,"required":["isLinked","transaction"],"properties":{"isLinked":{"type":"boolean","isRequired":true,"uniqueKey":"bankLink.isLinked","typeLabel":"boolean"},"transaction":{"oneOf":[{"type":"object","additionalProperties":false,"required":["id","date","amount","description"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"bankLink.transaction.oneOf.0.id","typeLabel":"string"},"date":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"bankLink.transaction.oneOf.0.date","typeLabel":"string\u003cdate-time>"},"amount":{"type":"number","isRequired":true,"uniqueKey":"bankLink.transaction.oneOf.0.amount","typeLabel":"number"},"description":{"type":"string","isRequired":true,"uniqueKey":"bankLink.transaction.oneOf.0.description","typeLabel":"string"}},"isRequired":true,"uniqueKey":"bankLink.transaction.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["id","date","amount","description"],"properties":{"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"amount":{"type":"number"},"description":{"type":"string"}},"isRequired":true,"uniqueKey":"bankLink.transaction.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bankLink.transaction","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"bankLink","typeLabel":"object"},"isFrozen":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"isFrozen","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"externalReference":{"oneOf":[{"type":"string","uniqueKey":"externalReference.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"externalReference.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalReference","typeLabel":"string | null"},"actualArrivalDate":{"oneOf":[{"type":"string","format":"date-time","description":"Calendar day represented as a UTC-midnight ISO timestamp.","uniqueKey":"actualArrivalDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Calendar day represented as a UTC-midnight ISO timestamp.","uniqueKey":"actualArrivalDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"actualArrivalDate","typeLabel":"string\u003cdate-time> | null"},"settlementType":{"oneOf":[{"type":"string","uniqueKey":"settlementType.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"settlementType.oneOf.1","typeLabel":"null"}],"uniqueKey":"settlementType","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"errorMessage","typeLabel":"string | null"},"failureCode":{"oneOf":[{"type":"string","uniqueKey":"failureCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"failureCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"failureCode","typeLabel":"string | null"},"depositBasis":{"oneOf":[{"type":"string","enum":["GROSS","NET"],"uniqueKey":"depositBasis.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["GROSS","NET"],"uniqueKey":"depositBasis.oneOf.1","typeLabel":"null"}],"uniqueKey":"depositBasis","typeLabel":"enum\u003cstring> | null"},"givingIntegration":{"oneOf":[{"type":"object","additionalProperties":false,"required":["id","provider","name"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"givingIntegration.oneOf.0.id","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"givingIntegration.oneOf.0.provider.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"givingIntegration.oneOf.0.provider.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"givingIntegration.oneOf.0.provider","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"givingIntegration.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"givingIntegration.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"givingIntegration.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"givingIntegration.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["id","provider","name"],"properties":{"id":{"type":"string"},"provider":{"oneOf":[{"type":"string"},{"type":"null"}]},"name":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"givingIntegration.oneOf.1","typeLabel":"null"}],"uniqueKey":"givingIntegration","typeLabel":"object | null"},"merchant":{"oneOf":[{"type":"object","additionalProperties":false,"required":["id","name","campusId","dimensionValueId"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"merchant.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"merchant.oneOf.0.name","typeLabel":"string"},"campusId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"merchant.oneOf.0.campusId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"merchant.oneOf.0.campusId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"merchant.oneOf.0.campusId","typeLabel":"string | null"},"dimensionValueId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"merchant.oneOf.0.dimensionValueId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"merchant.oneOf.0.dimensionValueId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"merchant.oneOf.0.dimensionValueId","typeLabel":"string | null"}},"uniqueKey":"merchant.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["id","name","campusId","dimensionValueId"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"campusId":{"oneOf":[{"type":"string"},{"type":"null"}]},"dimensionValueId":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"merchant.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant","typeLabel":"object | null"},"dimensions":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["dimensionId","dimensionValueId"],"properties":{"dimensionId":{"type":"string","isRequired":true,"uniqueKey":"dimensions.items.[INDEX].dimensionId","typeLabel":"string"},"dimensionValueId":{"type":"string","isRequired":true,"uniqueKey":"dimensions.items.[INDEX].dimensionValueId","typeLabel":"string"},"dimensionName":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"dimensions.items.[INDEX].dimensionName.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"dimensions.items.[INDEX].dimensionName.oneOf.1","typeLabel":"null"}],"uniqueKey":"dimensions.items.[INDEX].dimensionName","typeLabel":"string | null"},"dimensionValueName":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"dimensions.items.[INDEX].dimensionValueName.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"dimensions.items.[INDEX].dimensionValueName.oneOf.1","typeLabel":"null"}],"uniqueKey":"dimensions.items.[INDEX].dimensionValueName","typeLabel":"string | null"}},"uniqueKey":"dimensions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"dimensions","typeLabel":"object[]"},"batches":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","externalReference","status","batchDate","totalNet"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"batches.items.[INDEX].id","typeLabel":"string"},"externalReference":{"type":"string","isRequired":true,"uniqueKey":"batches.items.[INDEX].externalReference","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"batches.items.[INDEX].status","typeLabel":"string"},"batchDate":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"batches.items.[INDEX].batchDate","typeLabel":"string\u003cdate-time>"},"totalNet":{"type":"number","isRequired":true,"uniqueKey":"batches.items.[INDEX].totalNet","typeLabel":"number"}},"uniqueKey":"batches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"batches","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","provider":"STRIPE","externalId":"\u003cstring>","estimatedArrivalDate":"2023-11-07T05:31:56Z","recordedTotals":{"gross":123,"fees":123,"net":123,"paymentCount":123,"donationCount":123},"linkedContributionTotals":{"gross":123,"fees":123,"net":123,"paymentCount":123,"donationCount":123},"currency":"\u003cstring>","status":"PENDING","accounting":{"disposition":"ELIGIBLE","reason":"\u003cstring>","journalEntry":{"id":"\u003cstring>","entryNumber":"\u003cstring>","referenceNumber":"\u003cstring>"}},"bankLink":{"isLinked":true,"transaction":{"id":"\u003cstring>","date":"2023-11-07T05:31:56Z","amount":123,"description":"\u003cstring>"}},"isFrozen":true,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","externalReference":"\u003cstring>","actualArrivalDate":"2023-11-07T05:31:56Z","settlementType":"\u003cstring>","errorMessage":"\u003cstring>","failureCode":"\u003cstring>","depositBasis":"GROSS","givingIntegration":{"id":"\u003cstring>","provider":"\u003cstring>","name":"\u003cstring>"},"merchant":{"id":"\u003cstring>","name":"\u003cstring>","campusId":"\u003cstring>","dimensionValueId":"\u003cstring>"},"dimensions":[{"dimensionId":"\u003cstring>","dimensionValueId":"\u003cstring>","dimensionName":"\u003cstring>","dimensionValueName":"\u003cstring>"}],"batches":[{"id":"\u003cstring>","externalReference":"\u003cstring>","status":"\u003cstring>","batchDate":"2023-11-07T05:31:56Z","totalNet":123}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3ada93de-b09f-4365-a376-8f2fe5e03916":{"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"description":"Bad request (missing header or invalid input)","content":{"application/json":{"schema":{"type":"object","description":"Every error response is valid JSON with this shape. The HTTP status code carries the outcome; `code` is a stable machine-readable form of it.","required":["code","message"],"properties":{"code":{"type":"string","enum":["bad_request","unauthorized","forbidden","not_found","conflict","unprocessable_entity","payload_too_large","rate_limited","internal_server_error"],"example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"You do not have access to this organization.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","deprecated":true,"description":"Deprecated alias for `message`. Read `message` instead.","example":"You do not have access to this organization.","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present for schema validation failures. Contains safe top-level field names and validation codes, never submitted values.","properties":{"fields":{"type":"array","maxItems":20,"items":{"type":"object","required":["field","code"],"properties":{"field":{"type":"string","example":"amount","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","example":"invalid_type","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"details.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.fields","typeLabel":"object[]"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"You do not have access to this organization.","error":"You do not have access to this organization.","details":{"fields":[{"field":"amount","code":"invalid_type"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"3cacc55a-fd48-45c0-8bae-80e02fd760fc":{"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"description":"Unauthorized (missing or invalid Bearer token)","content":{"application/json":{"schema":{"type":"object","description":"Every error response is valid JSON with this shape. The HTTP status code carries the outcome; `code` is a stable machine-readable form of it.","required":["code","message"],"properties":{"code":{"type":"string","enum":["bad_request","unauthorized","forbidden","not_found","conflict","unprocessable_entity","payload_too_large","rate_limited","internal_server_error"],"example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"You do not have access to this organization.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","deprecated":true,"description":"Deprecated alias for `message`. Read `message` instead.","example":"You do not have access to this organization.","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present for schema validation failures. Contains safe top-level field names and validation codes, never submitted values.","properties":{"fields":{"type":"array","maxItems":20,"items":{"type":"object","required":["field","code"],"properties":{"field":{"type":"string","example":"amount","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","example":"invalid_type","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"details.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.fields","typeLabel":"object[]"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"You do not have access to this organization.","error":"You do not have access to this organization.","details":{"fields":[{"field":"amount","code":"invalid_type"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"eb86bd42-ac32-414b-9f53-f4d4b533a42c":{"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"description":"Forbidden (no access to organization or action)","content":{"application/json":{"schema":{"type":"object","description":"Every error response is valid JSON with this shape. The HTTP status code carries the outcome; `code` is a stable machine-readable form of it.","required":["code","message"],"properties":{"code":{"type":"string","enum":["bad_request","unauthorized","forbidden","not_found","conflict","unprocessable_entity","payload_too_large","rate_limited","internal_server_error"],"example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"You do not have access to this organization.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","deprecated":true,"description":"Deprecated alias for `message`. Read `message` instead.","example":"You do not have access to this organization.","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present for schema validation failures. Contains safe top-level field names and validation codes, never submitted values.","properties":{"fields":{"type":"array","maxItems":20,"items":{"type":"object","required":["field","code"],"properties":{"field":{"type":"string","example":"amount","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","example":"invalid_type","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"details.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.fields","typeLabel":"object[]"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"You do not have access to this organization.","error":"You do not have access to this organization.","details":{"fields":[{"field":"amount","code":"invalid_type"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"22af88da-95a2-44a1-9eb4-11a8082161d3":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","description":"Every error response is valid JSON with this shape. The HTTP status code carries the outcome; `code` is a stable machine-readable form of it.","required":["code","message"],"properties":{"code":{"type":"string","enum":["bad_request","unauthorized","forbidden","not_found","conflict","unprocessable_entity","payload_too_large","rate_limited","internal_server_error"],"example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"You do not have access to this organization.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","deprecated":true,"description":"Deprecated alias for `message`. Read `message` instead.","example":"You do not have access to this organization.","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present for schema validation failures. Contains safe top-level field names and validation codes, never submitted values.","properties":{"fields":{"type":"array","maxItems":20,"items":{"type":"object","required":["field","code"],"properties":{"field":{"type":"string","example":"amount","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","example":"invalid_type","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"details.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.fields","typeLabel":"object[]"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"You do not have access to this organization.","error":"You do not have access to this organization.","details":{"fields":[{"field":"amount","code":"invalid_type"}]}}}},"exampleType":"generated"}},"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"9e8f9921-f1fc-41c7-86e0-771baf4d88a6":{"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"description":"Conflict (duplicate, cross-resource ownership conflict, concurrent change, or accounting-frozen resource)","content":{"application/json":{"schema":{"type":"object","description":"Every error response is valid JSON with this shape. The HTTP status code carries the outcome; `code` is a stable machine-readable form of it.","required":["code","message"],"properties":{"code":{"type":"string","enum":["bad_request","unauthorized","forbidden","not_found","conflict","unprocessable_entity","payload_too_large","rate_limited","internal_server_error"],"example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"You do not have access to this organization.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","deprecated":true,"description":"Deprecated alias for `message`. Read `message` instead.","example":"You do not have access to this organization.","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present for schema validation failures. Contains safe top-level field names and validation codes, never submitted values.","properties":{"fields":{"type":"array","maxItems":20,"items":{"type":"object","required":["field","code"],"properties":{"field":{"type":"string","example":"amount","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","example":"invalid_type","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"details.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.fields","typeLabel":"object[]"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"You do not have access to this organization.","error":"You do not have access to this organization.","details":{"fields":[{"field":"amount","code":"invalid_type"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"82afc889-a9d2-4301-ac9e-f0882ad77159":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","description":"Every error response is valid JSON with this shape. The HTTP status code carries the outcome; `code` is a stable machine-readable form of it.","required":["code","message"],"properties":{"code":{"type":"string","enum":["bad_request","unauthorized","forbidden","not_found","conflict","unprocessable_entity","payload_too_large","rate_limited","internal_server_error"],"example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"You do not have access to this organization.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","deprecated":true,"description":"Deprecated alias for `message`. Read `message` instead.","example":"You do not have access to this organization.","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present for schema validation failures. Contains safe top-level field names and validation codes, never submitted values.","properties":{"fields":{"type":"array","maxItems":20,"items":{"type":"object","required":["field","code"],"properties":{"field":{"type":"string","example":"amount","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","example":"invalid_type","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"details.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.fields","typeLabel":"object[]"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"You do not have access to this organization.","error":"You do not have access to this organization.","details":{"fields":[{"field":"amount","code":"invalid_type"}]}}}},"exampleType":"generated"}},"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"ca834005-f0ac-4f18-bd0a-69793a114906":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","description":"Every error response is valid JSON with this shape. The HTTP status code carries the outcome; `code` is a stable machine-readable form of it.","required":["code","message"],"properties":{"code":{"type":"string","enum":["bad_request","unauthorized","forbidden","not_found","conflict","unprocessable_entity","payload_too_large","rate_limited","internal_server_error"],"example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"You do not have access to this organization.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","deprecated":true,"description":"Deprecated alias for `message`. Read `message` instead.","example":"You do not have access to this organization.","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present for schema validation failures. Contains safe top-level field names and validation codes, never submitted values.","properties":{"fields":{"type":"array","maxItems":20,"items":{"type":"object","required":["field","code"],"properties":{"field":{"type":"string","example":"amount","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","example":"invalid_type","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"details.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.fields","typeLabel":"object[]"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"You do not have access to this organization.","error":"You do not have access to this organization.","details":{"fields":[{"field":"amount","code":"invalid_type"}]}}}},"exampleType":"generated"}},"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"70af9f0e-6083-4843-b8b4-0be94a10a461":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Every error response is valid JSON with this shape. The HTTP status code carries the outcome; `code` is a stable machine-readable form of it.","required":["code","message"],"properties":{"code":{"type":"string","enum":["bad_request","unauthorized","forbidden","not_found","conflict","unprocessable_entity","payload_too_large","rate_limited","internal_server_error"],"example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"You do not have access to this organization.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","deprecated":true,"description":"Deprecated alias for `message`. Read `message` instead.","example":"You do not have access to this organization.","uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present for schema validation failures. Contains safe top-level field names and validation codes, never submitted values.","properties":{"fields":{"type":"array","maxItems":20,"items":{"type":"object","required":["field","code"],"properties":{"field":{"type":"string","example":"amount","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","example":"invalid_type","isRequired":true,"uniqueKey":"details.fields.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"details.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.fields","typeLabel":"object[]"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"You do not have access to this organization.","error":"You do not have access to this organization.","details":{"fields":[{"field":"amount","code":"invalid_type"}]}}}},"exampleType":"generated"}},"headers":{"X-Request-Id":{"description":"Server-generated ID linking this request to API activity and audit records.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"}},"security":{"b13aa5d4-77e1-4461-944f-0c8c2480e9b6":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"grain_live_… or grain_test_…","description":"Organization API key created in Grain Settings → API. The key determines the organization and is limited to its assigned resource scopes. Write scopes imply the corresponding read scope.","scopes":[],"schemeName":"ApiKeyAuth"}},"0a4ca29a-fd5e-40fa-afd3-39cd795826a4":{"GrainOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.grainledger.com/auth/v1/oauth/authorize","tokenUrl":"https://auth.grainledger.com/auth/v1/oauth/token","scopes":{"openid":"OpenID Connect","email":"Email address","profile":"Profile information"}}},"scopes":[],"schemeName":"GrainOAuth2"}},"5d65a984-a73a-4263-a6ec-edd6bb054d60":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth access token (JWT)","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"f6713c7b-79dc-4516-9fa4-b80a2e5b565a":{"url":"https://api.grainledger.com","description":"API Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"grain_live_… or grain_test_…","description":"Organization API key created in Grain Settings → API. The key determines the organization and is limited to its assigned resource scopes. Write scopes imply the corresponding read scope.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization API key created in Grain Settings → API. The key determines the organization and is limited to its assigned resource scopes. Write scopes imply the corresponding read scope.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.grainledger.com/auth/v1/oauth/authorize","tokenUrl":"https://auth.grainledger.com/auth/v1/oauth/token","scopes":{"openid":"OpenID Connect","email":"Email address","profile":"Profile information"}}},"scopes":[],"schemeName":"GrainOAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"GrainOAuth2","name":"Authorization"}],"title":"GrainOAuth2"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth access token (JWT)","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"OAuth access token (JWT)","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"grainledger","siteName":"Grain API","title":"Create settlement - Grain API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-10T15:49:06.109Z","originalFileLocation":"api-reference/settlements/create-settlement.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=\"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Grain API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_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=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create settlement - Grain API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Grain API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.grainledger.com/api-reference/settlements/create-settlement\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://grainledger.com/og-image.jpg?v=wheat-field-20260908\">\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=\"Create settlement - Grain API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://grainledger.com/og-image.jpg?v=wheat-field-20260908\">\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=\"/mintlify-assets/_mintlify/favicons/grainledger/PJpRtk0ZdVq1mTks/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Grain API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#03440c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.grainledger.com/api-reference/settlements/create-settlement\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/settlements/create-settlement.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.grainledger.com/#organization\",\"name\":\"Grain API\",\"url\":\"https://docs.grainledger.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/grainledger/Jxl-ZANCEY95i3PU/images/grain-wordmark-on-light.svg?fit=max\u0026auto=format\u0026n=Jxl-ZANCEY95i3PU\u0026q=85\u0026s=47f8188964661273a33f4901a311ba81\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.grainledger.com#website\",\"name\":\"Grain API\",\"url\":\"https://docs.grainledger.com\",\"publisher\":{\"@id\":\"https://docs.grainledger.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.grainledger.com/api-reference/settlements/create-settlement#webpage\",\"url\":\"https://docs.grainledger.com/api-reference/settlements/create-settlement\",\"name\":\"Create settlement\",\"description\":\"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.\",\"dateModified\":\"2026-10-10T15:49:06.109Z\",\"isPartOf\":{\"@id\":\"https://docs.grainledger.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.grainledger.com/api-reference/settlements/create-settlement#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.grainledger.com/api-reference/settlements/create-settlement#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Settlements\",\"item\":\"https://docs.grainledger.com/api-reference/settlements/list-settlements\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create settlement\",\"item\":\"https://docs.grainledger.com/api-reference/settlements/create-settlement\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.grainledger.com/api-reference/settlements/create-settlement#apireference\",\"headline\":\"Create settlement\",\"name\":\"Create settlement\",\"description\":\"Creates a resource record only. It never posts a journal entry, links a bank transaction, or reconciles accounting. contributionIds and givingBatchIds are applied atomically.\",\"url\":\"https://docs.grainledger.com/api-reference/settlements/create-settlement\",\"mainEntityOfPage\":{\"@id\":\"https://docs.grainledger.com/api-reference/settlements/create-settlement#webpage\"},\"image\":\"https://grainledger.com/og-image.jpg?v=wheat-field-20260908\",\"dateModified\":\"2026-10-10T15:49:06.109Z\",\"publisher\":{\"@id\":\"https://docs.grainledger.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.grainledger.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Grain API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Grain API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/settlements/create-settlement.md","siteName":"Grain API","nav":{"global":{"anchors":[{"anchor":"Open app","icon":"https://mintlify.s3.us-west-1.amazonaws.com/grainledger/images/grain-logomark.svg","href":"https://app.grainledger.com"},{"anchor":"Support","icon":"circle-question","href":"https://grainledger.com/support"}]},"tabs":[{"tab":"Getting Started","icon":"rocket","pages":[{"title":"Getting Started","href":"/intro"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Funds","pages":[{"title":"List funds","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/funds","href":"/api-reference/funds/list-funds"}]},{"group":"Coding Reference Data","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/accounts","href":"/api-reference/coding-reference-data/list-accounts"},{"title":"List dimensions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/dimensions","href":"/api-reference/coding-reference-data/list-dimensions"},{"title":"List vendors","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/vendors","href":"/api-reference/coding-reference-data/list-vendors"}]},{"group":"Organizations","pages":[{"title":"List authorized organizations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/organizations","href":"/api-reference/organizations/list-authorized-organizations"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Create transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/transactions","href":"/api-reference/transactions/create-transaction"},{"title":"Get transaction by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/transactions/{id}","href":"/api-reference/transactions/get-transaction-by-id"},{"title":"Delete transaction","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/transactions/{id}","href":"/api-reference/transactions/delete-transaction"},{"title":"Update transaction","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/transactions/{id}","href":"/api-reference/transactions/update-transaction"},{"title":"Code or split a transaction","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/transactions/{id}/coding","href":"/api-reference/transactions/code-or-split-a-transaction"},{"title":"Uncategorize a transaction","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/transactions/{id}/coding","href":"/api-reference/transactions/uncategorize-a-transaction"},{"title":"Set transaction dimensions","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/transactions/{id}/dimensions","href":"/api-reference/transactions/set-transaction-dimensions"},{"title":"Approve a transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/transactions/{id}/approve","href":"/api-reference/transactions/approve-a-transaction"},{"title":"Unapprove a transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/transactions/{id}/unapprove","href":"/api-reference/transactions/unapprove-a-transaction"},{"title":"List transaction attachments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/transactions/{id}/attachments","href":"/api-reference/transactions/list-transaction-attachments"},{"title":"Upload a receipt","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/transactions/{id}/attachments","href":"/api-reference/transactions/upload-a-receipt"},{"title":"Get an attachment download URL","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/transactions/{id}/attachments/{fileId}/download","href":"/api-reference/transactions/get-an-attachment-download-url"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/transactions/{id}/attachments/{fileId}","href":"/api-reference/transactions/delete-an-attachment"}]},{"group":"Bills","pages":[{"title":"List bills","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/bills","href":"/api-reference/bills/list-bills"},{"title":"Create bill","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/bills","href":"/api-reference/bills/create-bill"},{"title":"Get bill","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/bills/{id}","href":"/api-reference/bills/get-bill"},{"title":"Delete bill","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/bills/{id}","href":"/api-reference/bills/delete-bill"},{"title":"Update bill","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/bills/{id}","href":"/api-reference/bills/update-bill"}]},{"group":"Donors","pages":[{"title":"List donors","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/donors","href":"/api-reference/donors/list-donors"},{"title":"Create donor","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/donors","href":"/api-reference/donors/create-donor"},{"title":"Get donor","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/donors/{id}","href":"/api-reference/donors/get-donor"},{"title":"Delete donor","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/donors/{id}","href":"/api-reference/donors/delete-donor"},{"title":"Update donor","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/donors/{id}","href":"/api-reference/donors/update-donor"}]},{"group":"Contributions","pages":[{"title":"List contributions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contributions","href":"/api-reference/contributions/list-contributions"},{"title":"Create contribution","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/contributions","href":"/api-reference/contributions/create-contribution"},{"title":"Get contribution","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contributions/{id}","href":"/api-reference/contributions/get-contribution"},{"title":"Delete contribution","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/contributions/{id}","href":"/api-reference/contributions/delete-contribution"},{"title":"Update contribution","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/contributions/{id}","href":"/api-reference/contributions/update-contribution"}]},{"group":"Settlements","pages":[{"title":"List settlements","description":"Returns recorded totals and independently calculated totals from linked contributions. dateFrom/dateTo filter the UTC calendar arrival day; dateTo is inclusive to callers.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/settlements","href":"/api-reference/settlements/list-settlements"},{"title":"Create settlement","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/settlements","href":"/api-reference/settlements/create-settlement"},{"title":"Get settlement","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/settlements/{id}","href":"/api-reference/settlements/get-settlement"},{"title":"Delete settlement","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/settlements/{id}","href":"/api-reference/settlements/delete-settlement"},{"title":"Update settlement","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/settlements/{id}","href":"/api-reference/settlements/update-settlement"}]},{"group":"Giving Batches","pages":[{"title":"List giving batches","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/batches","href":"/api-reference/giving-batches/list-giving-batches"},{"title":"Create giving batch","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/batches","href":"/api-reference/giving-batches/create-giving-batch"},{"title":"Get giving batch","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/batches/{id}","href":"/api-reference/giving-batches/get-giving-batch"},{"title":"Delete giving batch","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/batches/{id}","href":"/api-reference/giving-batches/delete-giving-batch"},{"title":"Update giving batch","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/batches/{id}","href":"/api-reference/giving-batches/update-giving-batch"}]},{"group":"Pledge Card Imports","pages":[{"title":"Import pledge card data for review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/pledge-card-imports","href":"/api-reference/pledge-card-imports/import-pledge-card-data-for-review"},{"title":"List pledge card import reference data","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/pledge-card-imports/reference-data","href":"/api-reference/pledge-card-imports/list-pledge-card-import-reference-data"}]},{"group":"Pledges","pages":[{"title":"List pledges","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/pledges","href":"/api-reference/pledges/list-pledges"},{"title":"Create pledge","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/pledges","href":"/api-reference/pledges/create-pledge"},{"title":"Get pledge","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/pledges/{id}","href":"/api-reference/pledges/get-pledge"},{"title":"Delete pledge","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/pledges/{id}","href":"/api-reference/pledges/delete-pledge"},{"title":"Update pledge","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/pledges/{id}","href":"/api-reference/pledges/update-pledge"}]},{"group":"Households","pages":[{"title":"List households","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/households","href":"/api-reference/households/list-households"},{"title":"Create household","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/households","href":"/api-reference/households/create-household"},{"title":"Get household","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/households/{id}","href":"/api-reference/households/get-household"},{"title":"Delete household","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/households/{id}","href":"/api-reference/households/delete-household"},{"title":"Update household","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/households/{id}","href":"/api-reference/households/update-household"},{"title":"Add household member","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/households/{id}/members","href":"/api-reference/households/add-household-member"},{"title":"Remove household member","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/households/{id}/members/{donorId}","href":"/api-reference/households/remove-household-member"},{"title":"Update household member","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/households/{id}/members/{donorId}","href":"/api-reference/households/update-household-member"}]}]}]},"basePath":"","title":"Create settlement - Grain API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}