Update contribution

curl --request PATCH \
  --url https://api.grainledger.com/api/v1/contributions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "donorId": "<string>",
  "sourceDonorId": "<string>",
  "amount": 1,
  "date": "2023-12-25",
  "fundId": "<string>",
  "isTaxDeductible": true,
  "checkNumber": "<string>",
  "checkDate": "2023-12-25",
  "notes": "<string>",
  "memo": "<string>",
  "givingBatchId": "<string>",
  "settlementId": "<string>",
  "givingMerchantId": "<string>",
  "processingFee": 1,
  "netAmount": 1,
  "feeCovered": true,
  "paymentLast4": "<string>",
  "paymentBrand": "<string>",
  "paymentMethodSub": "<string>",
  "paymentMethodType": "<string>",
  "paymentSource": "<string>",
  "isRefunded": true,
  "refundedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "externalDonorId": "<string>",
  "givingEventKey": "<string>",
  "benefitDescription": "<string>",
  "benefitValue": 1,
  "deductibleAmount": 1,
  "stockTicker": "<string>",
  "stockShares": 1,
  "stockFmvPerShare": 1,
  "stockTransferDate": "2023-12-25",
  "inKindDescription": "<string>",
  "inKindFmv": 1,
  "inKindAppraisalDate": "2023-12-25",
  "foreignCurrency": "<string>",
  "foreignAmount": 123,
  "exchangeRate": 123
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    donorId: '<string>',
    sourceDonorId: '<string>',
    amount: 1,
    date: '2023-12-25',
    fundId: '<string>',
    isTaxDeductible: true,
    checkNumber: '<string>',
    checkDate: '2023-12-25',
    notes: '<string>',
    memo: '<string>',
    givingBatchId: '<string>',
    settlementId: '<string>',
    givingMerchantId: '<string>',
    processingFee: 1,
    netAmount: 1,
    feeCovered: true,
    paymentLast4: '<string>',
    paymentBrand: '<string>',
    paymentMethodSub: '<string>',
    paymentMethodType: '<string>',
    paymentSource: '<string>',
    isRefunded: true,
    refundedAt: '2023-11-07T05:31:56Z',
    completedAt: '2023-11-07T05:31:56Z',
    externalId: '<string>',
    externalDonorId: '<string>',
    givingEventKey: '<string>',
    benefitDescription: '<string>',
    benefitValue: 1,
    deductibleAmount: 1,
    stockTicker: '<string>',
    stockShares: 1,
    stockFmvPerShare: 1,
    stockTransferDate: '2023-12-25',
    inKindDescription: '<string>',
    inKindFmv: 1,
    inKindAppraisalDate: '2023-12-25',
    foreignCurrency: '<string>',
    foreignAmount: 123,
    exchangeRate: 123
  })
};

fetch('https://api.grainledger.com/api/v1/contributions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.grainledger.com/api/v1/contributions/{id}"

payload = {
    "donorId": "<string>",
    "sourceDonorId": "<string>",
    "amount": 1,
    "date": "2023-12-25",
    "fundId": "<string>",
    "isTaxDeductible": True,
    "checkNumber": "<string>",
    "checkDate": "2023-12-25",
    "notes": "<string>",
    "memo": "<string>",
    "givingBatchId": "<string>",
    "settlementId": "<string>",
    "givingMerchantId": "<string>",
    "processingFee": 1,
    "netAmount": 1,
    "feeCovered": True,
    "paymentLast4": "<string>",
    "paymentBrand": "<string>",
    "paymentMethodSub": "<string>",
    "paymentMethodType": "<string>",
    "paymentSource": "<string>",
    "isRefunded": True,
    "refundedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "externalDonorId": "<string>",
    "givingEventKey": "<string>",
    "benefitDescription": "<string>",
    "benefitValue": 1,
    "deductibleAmount": 1,
    "stockTicker": "<string>",
    "stockShares": 1,
    "stockFmvPerShare": 1,
    "stockTransferDate": "2023-12-25",
    "inKindDescription": "<string>",
    "inKindFmv": 1,
    "inKindAppraisalDate": "2023-12-25",
    "foreignCurrency": "<string>",
    "foreignAmount": 123,
    "exchangeRate": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "donorId": "<string>",
  "sourceDonorId": "<string>",
  "amount": 123,
  "date": "2023-11-07T05:31:56Z",
  "fundId": "<string>",
  "method": "CASH",
  "isTaxDeductible": true,
  "externalSource": "<string>",
  "givingBatchId": "<string>",
  "settlementId": "<string>",
  "givingMerchantId": "<string>",
  "processingFee": 123,
  "netAmount": 123,
  "feeCovered": true,
  "payment": {
    "status": "PENDING",
    "last4": "<string>",
    "brand": "<string>",
    "methodSubtype": "<string>",
    "methodType": "<string>",
    "source": "<string>",
    "isRefunded": true,
    "refundedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  },
  "settlementState": {
    "isSettled": true,
    "settlementDate": "2023-11-07T05:31:56Z",
    "settlementBatch": "<string>",
    "isCleared": true,
    "clearedAt": "2023-11-07T05:31:56Z"
  },
  "sourceType": "DIRECT",
  "quidProQuo": {
    "benefitDescription": "<string>",
    "benefitValue": 123,
    "deductibleAmount": 123
  },
  "stock": {
    "ticker": "<string>",
    "shares": 123,
    "fairMarketValuePerShare": 123,
    "transferDate": "2023-11-07T05:31:56Z"
  },
  "inKind": {
    "description": "<string>",
    "fairMarketValue": 123,
    "appraisalDate": "2023-11-07T05:31:56Z"
  },
  "foreignCurrency": "<string>",
  "foreignAmount": 123,
  "exchangeRate": 123,
  "donor": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "organizationName": "<string>",
    "donorType": "<string>"
  },
  "sourceDonor": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "organizationName": "<string>",
    "donorType": "<string>"
  },
  "fund": {
    "id": "<string>",
    "name": "<string>",
    "fundType": "<string>"
  },
  "batch": {
    "id": "<string>",
    "externalReference": "<string>",
    "batchDate": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "totalGross": 123,
    "totalFees": 123,
    "totalNet": 123,
    "donationCount": 123
  },
  "settlement": {
    "id": "<string>",
    "provider": "<string>",
    "externalReference": "<string>",
    "estimatedArrivalDate": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "totalNet": 123
  },
  "journalEntry": {
    "id": "<string>",
    "entryNumber": "<string>",
    "referenceNumber": "<string>"
  },
  "merchant": {
    "id": "<string>",
    "name": "<string>",
    "campus": {
      "id": "<string>",
      "name": "<string>"
    },
    "dimensionValue": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "checkNumber": "<string>",
  "checkDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "memo": "<string>",
  "externalId": "<string>",
  "externalDonorId": "<string>",
  "givingEventKey": "<string>"
}

{
  "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"
      }
    ]
  }
}

PATCH

https://api.grainledger.com

api

contributions

{id}

Update contribution

curl --request PATCH \
  --url https://api.grainledger.com/api/v1/contributions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "donorId": "<string>",
  "sourceDonorId": "<string>",
  "amount": 1,
  "date": "2023-12-25",
  "fundId": "<string>",
  "isTaxDeductible": true,
  "checkNumber": "<string>",
  "checkDate": "2023-12-25",
  "notes": "<string>",
  "memo": "<string>",
  "givingBatchId": "<string>",
  "settlementId": "<string>",
  "givingMerchantId": "<string>",
  "processingFee": 1,
  "netAmount": 1,
  "feeCovered": true,
  "paymentLast4": "<string>",
  "paymentBrand": "<string>",
  "paymentMethodSub": "<string>",
  "paymentMethodType": "<string>",
  "paymentSource": "<string>",
  "isRefunded": true,
  "refundedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "externalDonorId": "<string>",
  "givingEventKey": "<string>",
  "benefitDescription": "<string>",
  "benefitValue": 1,
  "deductibleAmount": 1,
  "stockTicker": "<string>",
  "stockShares": 1,
  "stockFmvPerShare": 1,
  "stockTransferDate": "2023-12-25",
  "inKindDescription": "<string>",
  "inKindFmv": 1,
  "inKindAppraisalDate": "2023-12-25",
  "foreignCurrency": "<string>",
  "foreignAmount": 123,
  "exchangeRate": 123
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    donorId: '<string>',
    sourceDonorId: '<string>',
    amount: 1,
    date: '2023-12-25',
    fundId: '<string>',
    isTaxDeductible: true,
    checkNumber: '<string>',
    checkDate: '2023-12-25',
    notes: '<string>',
    memo: '<string>',
    givingBatchId: '<string>',
    settlementId: '<string>',
    givingMerchantId: '<string>',
    processingFee: 1,
    netAmount: 1,
    feeCovered: true,
    paymentLast4: '<string>',
    paymentBrand: '<string>',
    paymentMethodSub: '<string>',
    paymentMethodType: '<string>',
    paymentSource: '<string>',
    isRefunded: true,
    refundedAt: '2023-11-07T05:31:56Z',
    completedAt: '2023-11-07T05:31:56Z',
    externalId: '<string>',
    externalDonorId: '<string>',
    givingEventKey: '<string>',
    benefitDescription: '<string>',
    benefitValue: 1,
    deductibleAmount: 1,
    stockTicker: '<string>',
    stockShares: 1,
    stockFmvPerShare: 1,
    stockTransferDate: '2023-12-25',
    inKindDescription: '<string>',
    inKindFmv: 1,
    inKindAppraisalDate: '2023-12-25',
    foreignCurrency: '<string>',
    foreignAmount: 123,
    exchangeRate: 123
  })
};

fetch('https://api.grainledger.com/api/v1/contributions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.grainledger.com/api/v1/contributions/{id}"

payload = {
    "donorId": "<string>",
    "sourceDonorId": "<string>",
    "amount": 1,
    "date": "2023-12-25",
    "fundId": "<string>",
    "isTaxDeductible": True,
    "checkNumber": "<string>",
    "checkDate": "2023-12-25",
    "notes": "<string>",
    "memo": "<string>",
    "givingBatchId": "<string>",
    "settlementId": "<string>",
    "givingMerchantId": "<string>",
    "processingFee": 1,
    "netAmount": 1,
    "feeCovered": True,
    "paymentLast4": "<string>",
    "paymentBrand": "<string>",
    "paymentMethodSub": "<string>",
    "paymentMethodType": "<string>",
    "paymentSource": "<string>",
    "isRefunded": True,
    "refundedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "externalDonorId": "<string>",
    "givingEventKey": "<string>",
    "benefitDescription": "<string>",
    "benefitValue": 1,
    "deductibleAmount": 1,
    "stockTicker": "<string>",
    "stockShares": 1,
    "stockFmvPerShare": 1,
    "stockTransferDate": "2023-12-25",
    "inKindDescription": "<string>",
    "inKindFmv": 1,
    "inKindAppraisalDate": "2023-12-25",
    "foreignCurrency": "<string>",
    "foreignAmount": 123,
    "exchangeRate": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "donorId": "<string>",
  "sourceDonorId": "<string>",
  "amount": 123,
  "date": "2023-11-07T05:31:56Z",
  "fundId": "<string>",
  "method": "CASH",
  "isTaxDeductible": true,
  "externalSource": "<string>",
  "givingBatchId": "<string>",
  "settlementId": "<string>",
  "givingMerchantId": "<string>",
  "processingFee": 123,
  "netAmount": 123,
  "feeCovered": true,
  "payment": {
    "status": "PENDING",
    "last4": "<string>",
    "brand": "<string>",
    "methodSubtype": "<string>",
    "methodType": "<string>",
    "source": "<string>",
    "isRefunded": true,
    "refundedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  },
  "settlementState": {
    "isSettled": true,
    "settlementDate": "2023-11-07T05:31:56Z",
    "settlementBatch": "<string>",
    "isCleared": true,
    "clearedAt": "2023-11-07T05:31:56Z"
  },
  "sourceType": "DIRECT",
  "quidProQuo": {
    "benefitDescription": "<string>",
    "benefitValue": 123,
    "deductibleAmount": 123
  },
  "stock": {
    "ticker": "<string>",
    "shares": 123,
    "fairMarketValuePerShare": 123,
    "transferDate": "2023-11-07T05:31:56Z"
  },
  "inKind": {
    "description": "<string>",
    "fairMarketValue": 123,
    "appraisalDate": "2023-11-07T05:31:56Z"
  },
  "foreignCurrency": "<string>",
  "foreignAmount": 123,
  "exchangeRate": 123,
  "donor": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "organizationName": "<string>",
    "donorType": "<string>"
  },
  "sourceDonor": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "organizationName": "<string>",
    "donorType": "<string>"
  },
  "fund": {
    "id": "<string>",
    "name": "<string>",
    "fundType": "<string>"
  },
  "batch": {
    "id": "<string>",
    "externalReference": "<string>",
    "batchDate": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "totalGross": 123,
    "totalFees": 123,
    "totalNet": 123,
    "donationCount": 123
  },
  "settlement": {
    "id": "<string>",
    "provider": "<string>",
    "externalReference": "<string>",
    "estimatedArrivalDate": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "totalNet": 123
  },
  "journalEntry": {
    "id": "<string>",
    "entryNumber": "<string>",
    "referenceNumber": "<string>"
  },
  "merchant": {
    "id": "<string>",
    "name": "<string>",
    "campus": {
      "id": "<string>",
      "name": "<string>"
    },
    "dimensionValue": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "checkNumber": "<string>",
  "checkDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "memo": "<string>",
  "externalId": "<string>",
  "externalDonorId": "<string>",
  "givingEventKey": "<string>"
}

{
  "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

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.

Path Parameters

string

required

Resource ID

Body

application/json

All fields are optional. Send null to clear a nullable field. Accounting-derived settlement and clearing fields are read-only.

donorId

string | null

Minimum string length: 1

sourceDonorId

string | null

Minimum string length: 1

amount

number

Required range: x > 0

date

string<date>

fundId

string

Minimum string length: 1

method

enum<string>

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

ONLINE,

STOCK,

OTHER

isTaxDeductible

boolean

checkNumber

string | null

checkDate

string<date> | null

notes

string | null

memo

string | null

Maximum string length: 2000

givingBatchId

string | null

Minimum string length: 1

settlementId

string | null

Minimum string length: 1

givingMerchantId

string | null

Minimum string length: 1

processingFee

number | null

Required range: x >= 0

netAmount

number | null

Required range: x >= 0

feeCovered

boolean

paymentStatus

enum<string>

Available options:

PENDING,

SUCCEEDED,

FAILED

paymentLast4

string | null

Maximum string length: 4

paymentBrand

string | null

Maximum string length: 100

paymentMethodSub

string | null

Maximum string length: 100

paymentMethodType

string | null

Maximum string length: 100

paymentSource

string | null

Maximum string length: 100

isRefunded

boolean

refundedAt

string<date-time> | null

completedAt

string<date-time> | null

sourceType

enum<string> | null

Available options:

DIRECT,

DAF,

QCD_IRA,

MATCHING,

FOUNDATION,

ESTATE

externalId

string | null

externalSource

enum<string>

Available options:

PUSHPAY,

PLANNING_CENTER,

CCB,

TITHELY,

SUBSPLASH,

ROCK_RMS,

MANUAL,

OTHER

externalDonorId

string | null

Maximum string length: 500

givingEventKey

string | null

Required string length: 1 - 500

benefitDescription

string | null

benefitValue

number | null

Required range: x >= 0

deductibleAmount

number | null

Required range: x >= 0

stockTicker

string | null

stockShares

number | null

Required range: x > 0

stockTransferDate

string<date> | null

inKindDescription

string | null

inKindFmv

number | null

Required range: x >= 0

inKindAppraisalDate

string<date> | null

foreignCurrency

string | null

foreignAmount

number | null

exchangeRate

number | null

Response

Updated contribution

Contribution detail with one-level resource summaries. Provider metadata and processor billing identity are never returned.

string

required

donorId

string | null

required

sourceDonorId

string | null

required

amount

number

required

date

string<date-time>

required

Calendar day represented as a UTC-midnight ISO timestamp.

fundId

string

required

method

enum<string>

required

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

ONLINE,

STOCK,

OTHER

isTaxDeductible

boolean

required

externalSource

string

required

givingBatchId

string | null

required

settlementId

string | null

required

givingMerchantId

string | null

required

processingFee

number | null

required

netAmount

number | null

required

feeCovered

boolean

required

payment

object

required

Hide child attributes

payment.status

enum<string>

required

Available options:

PENDING,

SUCCEEDED,

FAILED

payment.last4

string | null

required

payment.brand

string | null

required

payment.methodSubtype

string | null

required

payment.methodType

string | null

required

payment.source

string | null

required

payment.isRefunded

boolean

required

payment.refundedAt

string<date-time> | null

required

payment.completedAt

string<date-time> | null

required

settlementState

object

required

read-only

Hide child attributes

settlementState.isSettled

boolean

required

settlementState.settlementDate

string<date-time> | null

required

settlementState.settlementBatch

string | null

required

settlementState.isCleared

boolean

required

settlementState.clearedAt

string<date-time> | null

required

sourceType

enum<string> | null

required

Available options:

DIRECT,

DAF,

QCD_IRA,

MATCHING,

FOUNDATION,

ESTATE

quidProQuo

object

required

Hide child attributes

quidProQuo.benefitDescription

string | null

required

quidProQuo.benefitValue

number | null

required

quidProQuo.deductibleAmount

number | null

required

stock

object

required

Hide child attributes

stock.ticker

string | null

required

stock.shares

number | null

required

stock.transferDate

string<date-time> | null

required

inKind

object

required

Hide child attributes

inKind.description

string | null

required

inKind.fairMarketValue

number | null

required

inKind.appraisalDate

string<date-time> | null

required

foreignCurrency

string | null

required

foreignAmount

number | null

required

exchangeRate

number | null

required

donor

object | null

required

Present only with donor identity access.

Hide child attributes

donor.id

string

required

donor.firstName

string | null

required

donor.lastName

string | null

required

donor.organizationName

string | null

required

donor.donorType

string | null

required

sourceDonor

object | null

required

Present only with donor identity access.

Hide child attributes

sourceDonor.id

string

required

sourceDonor.firstName

string | null

required

sourceDonor.lastName

string | null

required

sourceDonor.organizationName

string | null

required

sourceDonor.donorType

string | null

required

fund

object | null

required

Hide child attributes

fund.id

string

required

fund.name

string

required

fund.fundType

string | null

required

batch

object | null

required

Hide child attributes

batch.id

string

required

batch.externalReference

string

required

batch.batchDate

string<date-time>

required

batch.status

string

required

batch.totalGross

number

required

batch.totalFees

number

required

batch.totalNet

number

required

batch.donationCount

integer

required

settlement

object | null

required

Hide child attributes

settlement.id

string

required

settlement.provider

string

required

settlement.externalReference

string | null

required

settlement.estimatedArrivalDate

string<date-time>

required

settlement.status

string

required

settlement.totalNet

number

required

journalEntry

object | null

required

Hide child attributes

journalEntry.id

string

required

journalEntry.entryNumber

string | null

required

journalEntry.referenceNumber

string | null

required

merchant

object | null

required

Hide child attributes

merchant.id

string

required

merchant.name

string

required

merchant.campus

object | null

required

Hide child attributes

merchant.campus.id

string

required

merchant.campus.name

string

required

merchant.dimensionValue

object | null

required

Hide child attributes

merchant.dimensionValue.id

string

required

merchant.dimensionValue.name

string

required

createdAt

string<date-time> | null

required

updatedAt

string<date-time> | null

required

checkNumber

string | null

checkDate

string<date-time> | null

Calendar day represented as a UTC-midnight ISO timestamp.

notes

string | null

memo

string | null

externalId

string | null

externalDonorId

string | null

Provider donor identifier. Null when the caller lacks donor identity access.

givingEventKey

string | null

Required string length: 1 - 500

Last modified on September 15, 2026

Funds

Organizations

Transactions

Bills

Donors

Contributions

Settlements

Giving Batches

Pledge Card Imports

Pledges

Households

Update contribution

Authorizations

Headers

Path Parameters

Body

Response