INVINSTR: Invoice instruction
An invoice instruction template defining how invoices should be formatted and what information to include or exclude.
Default definition. This article describes the default
INVINSTR 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 INVINSTR.Entity properties
| Property | Value |
|---|---|
| Entity code | INVINSTR |
| Display name | Invoice instruction |
| Plural | Invoice instructions |
| Level | 250 |
Use cases
INVINSTR defines client-specific invoicing rules that control how invoices are generated. It is referenced from both CLIENT and COM records via the Invoice instructions objectLookup in the Administration panel. The entity captures whether a PO number is required on invoices (porequired), whether timesheets should be attached (timesheets), whether all items should be consolidated into a single invoice (consolidate), and several exclusion flags for sensitive data: exclude candidate name, exclude pay details, and exclude date.
Fields
Invoice instruction
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
code | text | Code. | |
description | text (multi-line) | Description. | |
porequired | boolean | PO required. | |
timesheets | boolean | Include timesheets. | |
consolidate | boolean | Consolidate all. | |
excludename | boolean | Exclude candidate name. | |
excludepay | boolean | Exclude pay details. | |
excludedate | boolean | Exclude date. |
Relationships
- No declared relationships in the default definition.
Creating a Invoice instruction via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "INVINSTR",
"level": 250,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"code": "...",
"description": "...",
"porequired": true
}Listing Invoice instructions
# All records in your tenant
GET /v1/entities/INVINSTR/SUB:<your-sub-id>