Update Report

PATCH

/reports/

Updates properties of an existing report.

Only the fields provided are changed; omitted fields remain
unchanged. When sections are provided, the existing sections and
their line items are replaced. Requires either an ID or an external
ID to identify the report.

Request

Body Params application/jsonRequired

Example

{
    "site": "67",
    "contact": "67",
    "owner": "65",
    "title": "HVAC Maintenance Invoice",
    "sales_tax_base": "exclusive",
    "purchase_tax_base": "exclusive",
    "project": "80",
    "is_sent": true,
    "payment_term": "80",
    "workflow": "87",
    "business_area": "66",
    "business_division": "66",
    "business_entity": "66",
    "url": "https://example.com/documents/INV-1001",
    "conditions": "<p>Payment is due within 30 days.</p>",
    "id": "4001",
    "external_id": "INV-EXT-1001",
    "is_locked": true,
    "sections": [
        {
            "description": "Cooling system service.",
            "line_items": [
                {
                    "inv_type": "PART",
                    "item_code": "ITEM-1001",
                    "qty": "2",
                    "sales_unit_price": "120.50",
                    "tax": "GST"
                }
            ]
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://app.fieldinsight.com/public-api//reports/' \
--header 'Content-Type: application/json' \
--data '{
    "site": "67",
    "contact": "67",
    "owner": "65",
    "title": "HVAC Maintenance Invoice",
    "sales_tax_base": "exclusive",
    "purchase_tax_base": "exclusive",
    "project": "80",
    "is_sent": true,
    "payment_term": "80",
    "workflow": "87",
    "business_area": "66",
    "business_division": "66",
    "business_entity": "66",
    "url": "https://example.com/documents/INV-1001",
    "conditions": "<p>Payment is due within 30 days.</p>",
    "id": "4001",
    "external_id": "INV-EXT-1001",
    "is_locked": true,
    "sections": [
        {
            "description": "Cooling system service.",
            "line_items": [
                {
                    "inv_type": "PART",
                    "item_code": "ITEM-1001",
                    "qty": "2",
                    "sales_unit_price": "120.50",
                    "tax": "GST"
                }
            ]
        }
    ]
}'

Responses

🟢200OK

application/json

Successful response.

Bodyapplication/json

Example

null

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🟠422Parameter Error

🟠429

Modified at 2026-10-30 03:40:11

Create Report

Delete Report