{ "opencollection": "1.0.0", "info": { "name": "Facilio REST Assets Invoices API", "version": "5.0.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Invoices", "type": "folder" }, "items": [ { "info": { "name": "List invoices", "type": "http" }, "http": { "method": "GET", "url": "https://{region}.facilioapis.com/{app_name}/api/v5/invoice", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number (1-based)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Records per page (max 200)" }, { "name": "select", "value": "", "type": "query", "description": "Comma-separated field names to include in the response" }, { "name": "expand", "value": "", "type": "query", "description": "Comma-separated lookup field names to expand on **list** endpoints (max 5).\nExpanded objects follow the same rules as single-record GET (see **Lookup fields in responses** in the API overview).\n" }, { "name": "search", "value": "", "type": "query", "description": "Free-text search on the primary field (subject, name, etc.)" }, { "name": "count", "value": "", "type": "query", "description": "Include total record count in response" }, { "name": "changed", "value": "", "type": "query", "description": "Delta sync: returns records created/modified after this UTC timestamp" }, { "name": "sortBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] }, "docs": "List invoices" }, { "info": { "name": "Create an invoice", "type": "http" }, "http": { "method": "POST", "url": "https://{region}.facilioapis.com/{app_name}/api/v5/invoice", "body": { "type": "json", "data": "{}" } }, "docs": "Create an invoice" }, { "info": { "name": "Get an invoice", "type": "http" }, "http": { "method": "GET", "url": "https://{region}.facilioapis.com/{app_name}/api/v5/invoice/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Record ID" }, { "name": "select", "value": "", "type": "query", "description": "Comma-separated field names to include in the response" }, { "name": "expand", "value": "", "type": "query", "description": "Comma-separated lookup field names to expand on **list** endpoints (max 5).\nExpanded objects follow the same rules as single-record GET (see **Lookup fields in responses** in the API overview).\n" } ] }, "docs": "Returns a single invoice with all fields and line items." }, { "info": { "name": "Update an invoice", "type": "http" }, "http": { "method": "PATCH", "url": "https://{region}.facilioapis.com/{app_name}/api/v5/invoice/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Record ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an invoice. When `lineItems` is included, it represents the full desired state.\nExisting line items not in the array are deleted. Include `id` to update an existing line item.\n" }, { "info": { "name": "Delete an invoice", "type": "http" }, "http": { "method": "DELETE", "url": "https://{region}.facilioapis.com/{app_name}/api/v5/invoice/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Record ID" } ] }, "docs": "Delete an invoice" }, { "info": { "name": "Get invoice field schema", "type": "http" }, "http": { "method": "GET", "url": "https://{region}.facilioapis.com/{app_name}/api/v5/invoice/metadata", "params": [ { "name": "includeAllowedValues", "value": "", "type": "query", "description": "When `true`, the metadata response adds `allowed_values` ([{label, value}]) on every picklist-capable field — `ENUM`, `SYSTEM_ENUM`, `MULTI_ENUM`, `STRING_SYSTEM_ENUM`, and `LOOKUP` fields targeting system picklist modules (status, priority, category, type, ...).\nDefault `false` keeps the original metadata payload (no enrichment, no extra DB calls).\nUse this to discover acceptable write values without round-tripping `GET /picklist/{moduleName}/{fieldName}` for every picklist field.\n" } ] }, "docs": "Returns the field schema for the invoice module, including all declared system fields and any org-specific custom fields with their data type, required/readOnly flags, and lookup targets." } ] } ], "bundled": true }