Some Disbursements endpoints share a common data model for requests; these are described below.
Disbursement
{
"contactId": "VN94T9H7815",
"amount": 23.32,
"designation": { "designationId": 501 },
"batchName": "MyBatchName",
"bankAccount": { "bankAccountId": 26 },
"checkNumber": "12345",
"date": "1925-04-10",
"disclosureFields": [
{
"disclosureFieldId": 30007,
"designationId": 501,
"value": "30028"
},
{
"disclosureFieldId": 30008,
"designationId": -1,
"value": "2016"
}
],
"note": "note goes here",
"sourceCode": { sourceCodeId: 42 },
"disbursementCreditCardLinkId": null,
"disbursementReimbursementLinkId": "VN8429H8VZ2"
}
Properties:
Key | Value |
---|---|
| Required String; The contact ID of the disbursement. |
| Required String; The amount of the disbursement. Value that has more than 2 digits after decimal point will not be accepted. |
|
|
|
|
| String; a free-form description of the batch of disbursements. Not related to contribution batches. |
| String; the check number associated with this disbursement, if any. |
| String; A date string between |
| String; A disbursement to link with this disbursement, if any. When disclosing a payment made to a credit card, use disbursementCreditCardLinkId to link disbursements itemizing each purchase made to the parent disbursement with which the bill was paid. Must be in the same designation as the disbursement in question, and must also associate the correct ExpenseSubtype disclosure field of |
| String; A disbursement to link with this disbursement, if any. When reimbursing an individual or organization for purchases made on your behalf, use disbursementReimbursementLinkId to link disbursements itemizing each purchase to the parent disbursement in which they are reimbursed. Must be in the same designation as the disbursement in question, and must also associate the correct ExpenseSubtype disclosure field of |
|
|
| A note detailing the disbursement. |
|
|
Disbursement Response
Successful disbursement creation returns the ID of the newly created disbursement. Example:
{
"disbursementId": "VN8429H8VZ2"
}
The status code of the response indicates whether a new disbursement was created (201
) or if an existing one was updated (200
).