List payments and collections
Scope: accounting:payments.read https://api.alladdin.com/api/v2/payments
Lists the money received (cobros) and paid out (pagos) recorded in the account, newest first, with its date, amount, banking account and the document it settles. Use it when the user asks about a collection or a payment, e.g. "show me the last collection" (último cobro) or "payments made this month" (pagos de este mes): pass type collection or payment, and narrow by dates, banking account or document. Not the payment methods configured in the account (métodos de pago: transfer, card, cash), which have their own list.
Parameters
Query parameters
start_date string<date-time> optional
Filter payments from this date onward. Accepts ISO 8601 datetime (e.g. 2024-01-01T00:00:00+00:00) or date only (e.g. 2024-01-01)
end_date string<date-time> optional
Filter payments up to this date. Accepts ISO 8601 datetime (e.g. 2024-12-31T23:59:59+00:00) or date only (e.g. 2024-12-31)
document_id string optional
Filter payments linked to this document. Combine with document_type to match a specific document
document_type string optional
Filter payments by document type. Can be used alone, or combined with document_id to match a specific document
type string optional
Filter by direction: "collection" for money received (cobro), "payment" for money paid out (pago)
"collection" "payment" banking_account_id string optional
Filter payments linked to this banking account
cursor string optional
Opaque cursor for pagination
limit integer optional = 50
Maximum number of payments to return per page
Request
import requests
url = "https://api.alladdin.com/api/v2/payments?start_date=2024-01-01T00:00:00+00:00&end_date=2024-12-31T23:59:59+00:00&document_id=value"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"items": [
{
"id": "507f1f77bcf86cd799439011",
"bank_account_id": "string",
"contact_id": "string",
"contact_name": "string",
"amount": "1500.50",
"description": "string",
"date": "2024-01-15T10:30:00+00:00",
"status": "no_paid",
"reconciliation_status": "pending",
"total_documents": "0.00",
"total_transactions": "0.00",
"total_advance": "0.00",
"document_type": "invoice",
"document_id": "507f1f77bcf86cd799439011"
}
],
"cursor": "string",
"has_more": false
}Success responses
200 List of payments application/json object items[] object[] id string
Payment unique identifier
bank_account_id string | null
Banking account identifier
contact_id string | null
Contact identifier
contact_name string | null
Contact display name
amount string
Payment amount as decimal string in the account's base currency (multi-currency invoices are pre-converted at recording time).
description string | null
Payment description
date string
Payment date in ISO 8601 format
status string
Payment status
Enum: no_paid paid partial_paid reconciliation_status string
Bank reconciliation status
Enum: pending reconciled partial_reconciled total_documents string
Total amount linked to documents
total_transactions string
Total amount linked to transactions
total_advance string
Total amount linked to advance payments
document_type string | null
Type of the linked source document. Legacy alias eg is normalized to entry before exposure.
Enum: invoice purchase creditnote salesreceipt estimate proform salesorder purchaseorder purchaserefund remittance payroll entry trans order receiptnote invoicingforecast expemployee `` document_id string | null
Identifier of the linked document
cursor string | null has_more boolean
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json