canonical: https://jentic.com/apis/palomma.com/palomma # Palomma Rentals API The Palomma Rentals API creates rental payment invoices for a merchant and reports how they were paid and settled. Creating an invoice takes a reference, amount, description, redirectUrl, and the tenant's customerDocumentNumber, with an optional documentType such as cc, ce, or nit, customerName, and contract, and the invoice returned carries a paymentUrl for the tenant to pay. Invoices can be listed by reference, contract, document number, payment date, or settlement date and cycle, and each settlement, fetched by date and cycle, reports the number of invoices, amount collected, fees, adjustments, and the payment amount. A sandbox host is available alongside production. ## For AI agents Create a Palomma rent invoice with a payment link for a tenant, check whether and how it was paid, and read the settlement for a date and cycle with amounts collected and fees. ## Scope Does not manage leases or tenants, issue refunds, or keep accounting ledgers. Use for creating Palomma rent invoices and reading their payments and settlements only. ## Capabilities - Issue a rent invoice with reference, amount, description, redirectUrl, and customerDocumentNumber, and get back a paymentUrl for the tenant - Look up invoices by reference, contract, or customerDocumentNumber to see status, paymentDate, paymentMethod, and paymentAmount - List invoices paid or settled on a date with the paymentDate, settlementDate, and settlementCycle filters, paging with limit and cursor - Read a settlement by date and cycle to reconcile numberOfInvoices, amountCollected, fees, feesPostpaid, adjustments, and paymentAmount - Test the invoice flow against the sandbox host before switching to production ## Use cases ### Agent-issued rent invoices through Jentic A property manager's agent bills tenants at the start of the month. Through Jentic it finds the createInvoice operation, sends the reference, amount, description, redirectUrl, and the tenant's customerDocumentNumber with the lease contract, and returns the paymentUrl to send to the tenant. Your own Jentic One instance injects the Palomma API key, so the agent never sees it. Example prompt: POST /invoices with reference 'APT-302-2026-11', amount 1800000, description 'November rent apartment 302', redirectUrl 'https://example.com/thanks', customerDocumentNumber '1020304050', documentType 'cc', and contract '2045', then return the paymentUrl ### Payment status follow-up Before sending a reminder, an agent checks which tenants have paid. Filtering GET /invoices by contract or customerDocumentNumber returns each invoice's status, paymentDate, and paymentMethod, so reminders go only to tenants whose invoice is still unpaid. Example prompt: GET /invoices with contract '2045', then report the status and paymentDate of the most recent invoice ### Settlement reconciliation Finance teams reconcile what Palomma deposited against what tenants paid. GET `/settlements/{date}/{cycle}` returns the settlement's numberOfInvoices, amountCollected, fees, feesPostpaid, adjustments, and paymentAmount, and GET /invoices with settlementDate and settlementCycle lists the invoices included in it. Example prompt: GET `/settlements/2026-11-05/1`, then GET /invoices with settlementDate '2026-11-05' and settlementCycle '1' and confirm the invoice amounts add up to amountCollected ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/invoices` | Create an invoice | | GET | `/invoices` | List invoices with filters | | GET | `/invoices/{id}` | Get an invoice by id | | GET | `/settlements/{date}/{cycle}` | Get a settlement by date and cycle | ## Key resources - **Invoices** — Create rent invoices with payment links, list them with filters, and fetch one by id - **Settlements** — Settlement totals, fees, and adjustments by date and cycle ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 69 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 100 / 100 - Developer Experience & Jentic Compatibility: 75 / 100 - AI-Readiness & Agent Experience: 50 / 100 - Agent Usability: 94 / 100 - Security: 60 / 100 - AI Discoverability: 66 / 100 - **View full report:** https://jentic.com/apis/palomma.com/palomma/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring Palomma by hand means bearer auth with your API key, choosing the sandbox or production host, and building invoice payloads with Colombian document types. Through Jentic you install once, import Palomma from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Palomma has one write, invoice creation, and three reads, so a rule can let a reconciliation agent read invoices and settlements while invoice creation stays out. The invoice id and settlement date and cycle sit in the URL path, so reads can also be pinned to one invoice or settlement. - **Credential handling:** Your Palomma API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a rent invoice' or 'get a settlement', and Jentic returns the matching Palomma operation with its input schema so the agent sends the required fields. ## Related APIs - **Stripe API** — General payment processing with invoices and payment links - **Buildium API** — Property management with leases, tenants, and accounting - **AppFolio API** — Property management platform data ## FAQ ### What authentication does the Palomma Rentals API use? The Palomma Rentals API uses HTTP bearer authentication per its OpenAPI spec: your Palomma API key sent as Authorization: Bearer followed by the key. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time, so it never enters the agent's prompt or logs. ### What fields are required to create a Palomma invoice? POST /invoices requires reference, amount, description, redirectUrl, and customerDocumentNumber. You can also send documentType, with values such as cc, ce, nit, or ppt, customerName, and contract to tie the invoice to a lease. ### Does the Palomma Rentals API have a sandbox? Yes. The spec lists https://sandbox.api.palomma.com/v1 alongside the production host https://api.palomma.com/v1, so you can create test invoices before going live. ### How do I send a rent payment link through Jentic? Install Jentic One, add the Palomma Rentals API from the Jentic API Directory, and store your Palomma API key once. Your agent searches for 'create a rent invoice', gets createInvoice with its input schema, calls POST /invoices, and returns the paymentUrl from the response. To run it on your own infrastructure, install Jentic One from its GitHub repo. ### Is there a Palomma MCP server? You don't need an MCP server to give your agent the Palomma Rentals API. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls it. ### Can I limit what my agent is allowed to do with the Palomma Rentals API? Yes. For a reconciliation agent, write a rule that allows only GET /invoices, GET `/invoices/{id}`, and GET `/settlements/{date}/{cycle}`: it can check payments and settlements but cannot issue new invoices. Your own Jentic One instance logs what it called.