PATENTRENEW: Patent Renewal
The PATENTRENEW entity represents a renewal or annuity payment record for maintaining a granted patent in force.
Default definition. This article describes the default
PATENTRENEW definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches PATENTRENEW.Entity properties
| Property | Value |
|---|---|
| Entity code | PATENTRENEW |
| Display name | Patent Renewal |
| Plural | Patent Renewals |
| Level | 430 |
Use cases
Child entity of PATENT for tracking renewal/annuity deadlines and payments. Two-column layout: left has renewal details (name, jurisdiction application link, renewal year, due date, grace period end), right has payment details (amount, currency, status, paid date, receipt reference). Linked to PATENT via SUB|PAT comboKey. Shown as relatedlist on PATENT Renewals panel.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
ownerId | reference → user | Created by. Read-only. | |
name | text | Yes | Renewal name. |
patentApp | reference → PATENTA | Jurisdiction application. | |
renewalYear | number | Renewal year. | |
dueDate | date | Yes | Due date. |
gracePeriodEnd | date | Grace period end. | |
amount | number | Amount. | |
currency | enum | Currency. Valid ids: GBP (GBP), USD (USD), EUR (EUR), CHF (CHF), JPY (JPY). | |
status | enum | Yes | Status. Valid ids: upcoming (Upcoming), due (Due), paid (Paid), overdue (Overdue), lapsed (Lapsed). |
paidDate | date | Date paid. | |
receiptRef | text | Receipt reference. |
Relationships
- Lookups:
patentApppoints atPATENTArecord.
Creating a Patent Renewal via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "PATENTRENEW",
"level": 430,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"dueDate": "2026-01-01",
"status": "upcoming",
"patentApp": ""
}
Listing PATENTRENEW records
# All patent renewals in your tenant
GET /v1/entities/PATENTRENEW/SUB