Sign in
Allocation payment

Create an allocation payment

Creates an allocation payment.

post/allocation-payment

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

x-api-languagestring[]

Defines the languages included in the response. If omitted, the account default language is used.

Value all overrides any other values present.

Request body

allocationstring required

Slug of the allocation the payment is drawn against.

amountnumber required

Amount of the payment, in the currency of the allocation's fund.

Cannot exceed the allocation's unscheduled balance.

date_duestring nullable

Date the payment is due.

Accepts Y-m-d or Y-m-d\TH:i:s\Z format.

date_paidstring nullable

Date the payment was made.

Accepts Y-m-d or Y-m-d\TH:i:s\Z format. Required when status is paid.

external_idstring nullable

External identifier of the payment, used to reconcile it with downstream systems.

payment_methodstring nullable

Slug of the payment method.

referencestring nullable

Free-text reference for the payment.

status'failed' | 'failed_permanently' | 'paid' | 'processing' | 'scheduled' required

Lifecycle status of the payment.

Response

Allocation payment created.

amountnumber

Amount of the payment, in the fund's currency.

commentsstring

Comment log attached to the payment, rendered as a newline-joined export string of author (timestamp): body entries. Empty string when the payment has no comments.

createdstring date-time

Date and time when the payment was created.

currencystring

ISO 4217 currency code of the payment's amounts, drawn from the fund's currency.

date_duestring date-time nullable

Date and time when the payment is due. null when no due date is set.

date_paidstring date-time nullable

Date and time when the payment was made. null when the payment has not been made.

external_idstring

External identifier of the payment, used to reconcile it with downstream systems. Empty string when none is set.

referencestring

Free-text reference for the payment. Empty string when none is set.

slugstring

URL-safe identifier of the payment.

statusstring

Lifecycle status of the payment, returned as a localised label rendered in the account's language.

Typical English labels are Scheduled, Processing, Paid, Failed, and Failed permanently.

updatedstring date-time

Date and time when the payment was last updated.

allocation_amountnumber

Total amount of the allocation the payment is drawn against, in the fund's currency.

Example response

{
  "allocation": {
    "slug": "NqqplzPl",
    "link": "https://api.au.cr4ce.com/allocation/NqqplzPl"
  },
  "allocation_amount": 500,
  "amount": 280.65,
  "comments": "",
  "created": "2024-03-19T14:00:25Z",
  "currency": "GBP",
  "date_due": null,
  "date_paid": null,
  "entrant": {
    "slug": "AbCdEfGh",
    "link": "https://api.au.cr4ce.com/user/AbCdEfGh",
    "name": "Ada Lovelace",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "email": "ada.lovelace@example.com",
    "global_id": "9c78dcbc-53cf-42f1-b5b3-82fe396f66e6"
  },
  "entry": {
    "slug": "PqRsTuVw",
    "id": 4821,
    "title": "Project title",
    "link": "https://api.au.cr4ce.com/entry/PqRsTuVw"
  },
  "external_id": "",
  "fund": {
    "slug": "PVzOmlXO",
    "link": "https://api.au.cr4ce.com/fund/PVzOmlXO",
    "name": {
      "en_GB": "Maintenance"
    }
  },
  "grant_status": null,
  "payment_method": null,
  "reference": "",
  "season": {
    "slug": "wboyrBmo",
    "link": "https://api.au.cr4ce.com/season/wboyrBmo",
    "name": {
      "en_GB": "2026"
    }
  },
  "slug": "oQKEeNDy",
  "status": "Scheduled",
  "updated": "2024-03-19T14:00:35Z"
}

Changes