POST

Create a payment for a purchase

Scope: accounting:purchases.write https://api.alladdin.com/api/v2/purchases/{purchaseId}/payments

Records a payment against the purchase invoice. The payment amount is deducted from the pending balance.
You can record partial payments by specifying an amount less than the total outstanding. The purchase status is automatically updated to paid when the pending balance reaches zero.

Parameters

Path parameters

purchaseId string required

Purchase ID (24-char hex ObjectId)

Request body

object amount string required

Payment amount

treasury_id string | null optional

Identifier of the treasury account. If omitted, the account default treasury is used.

date string<date> optional

Payment date in ISO 8601 format

description string | null optional

Free-text description of the payment

Request

python

import requests

url = "https://api.alladdin.com/api/v2/purchases/{purchaseId}/payments"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "amount": "100.00",
    "treasury_id": "string",
    "date": "2024-01-15",
    "description": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

Response

json

{
  "id": "507f1f77bcf86cd799439011"
}

Success responses

201 Payment created application/json object id string

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Purchase not found application/json 429 Rate limit exceeded application/json

← PreviousCreate a purchase →

Next →Approve a purchase →

Alladdin