Skip to main content
POST

Create a payment for a receipt note

Scope:sales:invoices.write
https://api.holded.com/api/v2/receipt-notes/{receiptNoteId}/payments

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

Parameters

Path parameters

receiptNoteIdstringrequired

Receipt Note ID (24-char hex ObjectId)

Request body

object
amountstring | null
datestring<date>

Payment date in ISO 8601 format

treasury_idstring | null

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

descriptionstring | null

Request

python
import requests

url = "https://api.holded.com/api/v2/receipt-notes/{receiptNoteId}/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

Response

json
{
  "id": "507f1f77bcf86cd799439011"
}

Success responses

201Payment createdapplication/json
object
idstring

Error responses

400Bad requestapplication/json
401Invalid or missing API keyapplication/json
403Insufficient permissionsapplication/json
404Receipt note not found.application/json
429Rate limit exceededapplication/json
500Internal server errorapplication/json
object
typestring
titlestring
statusinteger
detailstring