Commitments

Preview allocation of a received gift to recipients

Requires bearer or API-key authentication, current organization scope and access to every selected recipient program. Gift/funding administration also follows the donations/reports permission policy. Only qualified received gifts with retained money in the organization currency can fund recipients. Campaign, peer-to-peer and trip records are excluded. Money-need programs derive whole monthly periods, retain any unused remainder and allow partial first-month coverage; slot programs require an explicit coverage end. Reads without writing funding rows. Planning problems are returned in a successful 200 response; invalid input or ineligible recipient-program types return 422. No revenue, payment method or commitment is created.

POST

admin

donations

{donation_id}

funding

preview

Preview allocation of a received gift to recipients

curl --request POST \
  --url https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_ids": [
    4711,
    4712
  ],
  "covered_from": "2026-11-01",
  "covered_through": "2026-11-30",
  "amounts": {
    "4711": 35,
    "4712": 35
  },
  "display_funder": "inherit"
}
'

import requests

url = "https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview"

payload = {
    "entity_ids": [4711, 4712],
    "covered_from": "2026-11-01",
    "covered_through": "2026-11-30",
    "amounts": {
        "4711": 35,
        "4712": 35
    },
    "display_funder": "inherit"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity_ids: [4711, 4712],
    covered_from: '2026-11-01',
    covered_through: '2026-11-30',
    amounts: {'4711': 35, '4712': 35},
    display_funder: 'inherit'
  })
};

fetch('https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entity_ids' => [
        4711,
        4712
    ],
    'covered_from' => '2026-11-01',
    'covered_through' => '2026-11-30',
    'amounts' => [
        '4711' => 35,
        '4712' => 35
    ],
    'display_funder' => 'inherit'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview"

	payload := strings.NewReader("{\n  \"entity_ids\": [\n    4711,\n    4712\n  ],\n  \"covered_from\": \"2026-11-01\",\n  \"covered_through\": \"2026-11-30\",\n  \"amounts\": {\n    \"4711\": 35,\n    \"4712\": 35\n  },\n  \"display_funder\": \"inherit\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity_ids\": [\n    4711,\n    4712\n  ],\n  \"covered_from\": \"2026-11-01\",\n  \"covered_through\": \"2026-11-30\",\n  \"amounts\": {\n    \"4711\": 35,\n    \"4712\": 35\n  },\n  \"display_funder\": \"inherit\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity_ids\": [\n    4711,\n    4712\n  ],\n  \"covered_from\": \"2026-11-01\",\n  \"covered_through\": \"2026-11-30\",\n  \"amounts\": {\n    \"4711\": 35,\n    \"4712\": 35\n  },\n  \"display_funder\": \"inherit\"\n}"

response = http.request(request)
puts response.read_body

{
  "rows": [
    {
      "entity_id": 123,
      "program_id": 123,
      "recipient_name": "<string>",
      "need_kind": "<string>",
      "period_minor": 123,
      "funded_monthly_minor": 123,
      "amount_minor": 123,
      "periods": 123,
      "covered_from": "2023-12-25",
      "covered_through": "2023-12-25",
      "previously_covered_through": "2023-12-25",
      "partial": true,
      "currency_code": "<string>",
      "monthly_amount": "35.00",
      "amount": "35.00",
      "remainder": "35.00"
    }
  ],
  "problems": {},
  "allocated": "35.00",
  "unallocated": "35.00",
  "available": "35.00",
  "currency_code": "<string>",
  "recipient_count": 123
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

donation_id

integer

required

Donation id.

Required range: x >= 1

Example:

123

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

entity_ids

integer[]

required

Organization-owned recipient IDs. Duplicates are removed before planning.

Required array length: 1 - 500 elements

Required range: x >= 1

covered_from

string<date> | null

Optional inclusive start. Otherwise starts on the gift date or the day after existing funding, whichever is later.

covered_through

string<date> | null

Optional inclusive end, validated after_or_equal:covered_from. Required by planning when the program has no monthly monetary target.

amounts

object | null

Optional amount map keyed by recipient ID. If non-empty, omitted selected IDs receive zero. Otherwise remaining gift value is split evenly, with the minor-unit remainder on the first recipient.

Show child attributes

display_funder

enum<string> | null

default:inherit

Funder display preference saved by apply. Preview accepts but does not use this value.

Available options:

inherit,

named,

anonymous,

null

Response

Preview allocation of a received gift to recipients response.

rows

object[]

Show child attributes

problems

Field-keyed planning problems. They are normal preview results; apply rejects the same problems with 422.

Show child attributes

allocated

string

Decimal major-unit amount serialized as a string with two decimal places.

Pattern: ^-?[0-9]+[.][0-9]{2}$

Example:

"35.00"

unallocated

string

Decimal major-unit amount serialized as a string with two decimal places.

Pattern: ^-?[0-9]+[.][0-9]{2}$

Example:

"35.00"

available

string

Decimal major-unit amount serialized as a string with two decimal places.

Pattern: ^-?[0-9]+[.][0-9]{2}$

Example:

"35.00"

currency_code

string

recipient_count

integer

Preview allocation of a received gift to recipients

curl --request POST \
  --url https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_ids": [
    4711,
    4712
  ],
  "covered_from": "2026-11-01",
  "covered_through": "2026-11-30",
  "amounts": {
    "4711": 35,
    "4712": 35
  },
  "display_funder": "inherit"
}
'

import requests

url = "https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview"

payload = {
    "entity_ids": [4711, 4712],
    "covered_from": "2026-11-01",
    "covered_through": "2026-11-30",
    "amounts": {
        "4711": 35,
        "4712": 35
    },
    "display_funder": "inherit"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity_ids: [4711, 4712],
    covered_from: '2026-11-01',
    covered_through: '2026-11-30',
    amounts: {'4711': 35, '4712': 35},
    display_funder: 'inherit'
  })
};

fetch('https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entity_ids' => [
        4711,
        4712
    ],
    'covered_from' => '2026-11-01',
    'covered_through' => '2026-11-30',
    'amounts' => [
        '4711' => 35,
        '4712' => 35
    ],
    'display_funder' => 'inherit'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview"

	payload := strings.NewReader("{\n  \"entity_ids\": [\n    4711,\n    4712\n  ],\n  \"covered_from\": \"2026-11-01\",\n  \"covered_through\": \"2026-11-30\",\n  \"amounts\": {\n    \"4711\": 35,\n    \"4712\": 35\n  },\n  \"display_funder\": \"inherit\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity_ids\": [\n    4711,\n    4712\n  ],\n  \"covered_from\": \"2026-11-01\",\n  \"covered_through\": \"2026-11-30\",\n  \"amounts\": {\n    \"4711\": 35,\n    \"4712\": 35\n  },\n  \"display_funder\": \"inherit\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/donations/{donation_id}/funding/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity_ids\": [\n    4711,\n    4712\n  ],\n  \"covered_from\": \"2026-11-01\",\n  \"covered_through\": \"2026-11-30\",\n  \"amounts\": {\n    \"4711\": 35,\n    \"4712\": 35\n  },\n  \"display_funder\": \"inherit\"\n}"

response = http.request(request)
puts response.read_body

{
  "rows": [
    {
      "entity_id": 123,
      "program_id": 123,
      "recipient_name": "<string>",
      "need_kind": "<string>",
      "period_minor": 123,
      "funded_monthly_minor": 123,
      "amount_minor": 123,
      "periods": 123,
      "covered_from": "2023-12-25",
      "covered_through": "2023-12-25",
      "previously_covered_through": "2023-12-25",
      "partial": true,
      "currency_code": "<string>",
      "monthly_amount": "35.00",
      "amount": "35.00",
      "remainder": "35.00"
    }
  ],
  "problems": {},
  "allocated": "35.00",
  "unallocated": "35.00",
  "available": "35.00",
  "currency_code": "<string>",
  "recipient_count": 123
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}