Create a payment for a sales receipt
Scope: sales:receipts.write https://api.alladdin.com/api/v2/sales-receipts/{salesReceiptId}/payments
Records a payment against the sales receipt. The payment amount is deducted from the pending balance.
You can record partial payments by specifying an amount less than the total outstanding. The sales receipt status is automatically updated to paid when the pending balance reaches zero.
Parameters
Path parameters
salesReceiptId string required
Sales Receipt ID (24-char hex ObjectId)
Request body
object amount string | null
Payment amount as a decimal string
date string<date>
Payment date in ISO 8601 format
treasury_id string | null
Identifier of the treasury account. If omitted, the account default treasury is used.
description string | null
Free-text description of the payment
Request
import requests
url = "https://api.alladdin.com/api/v2/sales-receipts/{salesReceiptId}/payments"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
payload = {
"amount": "100.00",
"date": "2024-01-15",
"treasury_id": "string",
"description": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Responses
Success responses
201 Payment created
Error responses
400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Sales receipt not found. application/json 429 Rate limit exceeded application/json