Common Models

The following is an example of a pledge.

{
    "pledgeId": 1000025252,
    "contactsPledgeId": 1000025252,
    "vanId": 10005165,
    "donorName": "Gordon, James",
    "donorNameFirstLast": "James Gordon",
    "designationId": 18754,
    "designationName": "Jane for Congress Committee",
    "designation": {
        "designationId": 739,
        "name": "Jane for Congress Committee",
        "officialName": "Jane for Congress Committee"
    },
    "amount": 100.0000,
    "datePledged": "2026-07-06T00:00:00Z",
    "date": "2026-07-06T00:00:00Z",
    "status": "Active",
    "statusId": 1,
    "remainingAmount": 100.0000,
    "pledgeTypeId": 1,
    "pledgeTypeName": "To Give",
    "sourceCodeName": "Call Time Source Code",
    "sourceCodeStaticPath": "Call Time Source Code",
    "commitmentLevelId": 2,
    "fulfillmentStatusId": 1,
    "disclosureFieldValues": [
        {
            "disclosureFieldId": 2001,
            "disclosureFieldValue": "50002",
            "designationId": -1
        },
        {
            "disclosureFieldId": 2002,
            "disclosureFieldValue": "2026",
            "designationId": -1
        }
    ]
}

The following is an overview of the Pledge object and its related objects. In some cases, the related object has a dedicated endpoint. In these cases, a link to those endpoints is provided.

Pledge

The required properties are vanId, designationId, datePledged, pledgeTypeId, commitmentLevelId, and fulfillmentStatusId.

Property	Type	Description
`pledgeId`	int	Read-only; Unique identifier for a Pledge in this context.
`contactsPledgeId`	int	Legacy Field; Please use `pledgeId`.
`vanId`	object	The Person who contributed.
`donorName`	string	The name of the donor in "Last Name, Frist Name" format.
`donorNameFirstLast`	string	The name of the donor in "First Name Last Name" format.
`designationId`	int	Unique identifier for a Designation this Pledge is associated wtih.
`designationName`	string	Read-only; The name of the Designation this Pledge is associated wtih.
`designation`	object	The financial entity which will receive this contribution.
`amount`	decimal	The amount of the Pledge. Non-positive values, and values that have more than 2 digits after the decimal point, will not be accepted. Pledges created without an amount will have their value set to Unknown.
`datePledged`	datetime	The date of this Pledge.
`date`	datetime	Legacy Field; Please use `datePledged`.
`status`	string	Legacy Field; Please use `fulfillmentStatusId`.
`statusId`	int	Legacy Field; Please use `fulfillmentStatusId`.
`remainingAmount`	decimal	The amount remaining to complete the Pledge. This value is calculated automatically by subtracting the value of contributions linked to the pledge from the Pledges original amount. This value will be zero for Unknown pledges.
`pledgeTypeId`	int	The type of Pledge: `1` = To Give, `2` = To Raise
`pledgeTypeName`	string	The type name for the Pledge: To Give, To Raise
`sourceCodeName`	string	Read-only; The name of the source code associated with the Pledge. (Can be empty.)
`sourceCodeStaticPath`	string	Read-only; The path of the source code associated with the Pledge. (Can be empty.)
`commitmentLevelId`	int	The commitment level of the Pledge: `1` = Hard (Promise), `2` = Soft (Intent), `3` = Not Specified
`fulfillmentStatusId`	int	The fulfillment status of the Pledge: `1` = Active, `2` = Inactive (Abandoned), `3` = Inactive (Forgiven), `4` = Completed
`disclosureFieldValues`	array	An array of Discolsure Field Value objects associated with the Pledge.

Designation

Property	Type	Description
`designationId`	int	The id of the Designation which receives this contribution.

Disclosure Field Values

Property	Type	Description
`disclosureFieldId`	int	Identifies the Disclosure Field. Together, the designation id and disclosure field id provide a unique identifier of a Disclosure Field.
`disclosureFieldValue`	string	The value of the Disclosure Field
`designationId`	int	The unique identifier of the Designation of the Disclosure Field