FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. Invoice
  • Lead
    • Creates a new lead with customer details, appointment preferences, and service information.
      POST
    • Fetches lead details based on the provided lead identifier.
      GET
  • Customer
    • Creates a new customer
      POST
    • Updates an existing customer
      PUT
    • Retrieve customer by phone number
      GET
    • Search customers with optional filters
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer details by ID
      GET
  • CustomerAttachments
    • Upload a file attachment to a customer record
      POST
    • Retrieve attachments for a customer
      GET
  • CustomerNotes
    • Create a note on a customer record
      POST
    • Retrieve all notes for a customer
      GET
    • Update an existing customer note
      PATCH
  • CustomerTags
    • Associate a tag with a customer
      POST
    • Remove a tag from a customer
      DELETE
    • Create a reusable customer tag
      POST
    • Retrieve tags
      GET
  • Item
    • Creates a new inventory item
      POST
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Bulk update inventory items
      PATCH
    • Updates an existing inventory item
      PATCH
    • Retrieve an inventory item by ID
      GET
  • ItemCategory
    • Retrieve list of item categories
    • Create a new item category
    • Retrieve item category by id.
    • Partially update an item category
  • SalesTaxCode
    • Retrieve list of sales tax codes
  • WorkOrder
    • Retrieve a paginated list of work orders
    • Retrieve a work order by ID
    • Retrieve work orders at a given address, most recent first
    • Create a new work order
    • Update an existing work order
    • Retrieve list of business units
    • Retrieve business unit by id.
    • Retrieve list of lead sources
    • Retrieve lead source by id.
  • Assignments
    • Retrieve all technician assignments for a work order
    • Assign a technician to a work order
    • Update a technician assignment's status
    • Remove a technician from a work order assignment
  • Agreement
    • Retrieve list of agreements
    • Retrieve agreement by id.
  • Invoice
    • Retrieve a paginated list of invoices
      GET
    • Retrieve an invoice by ID
      GET
    • Create or update the invoice on a work order
      PUT
  • Quote
    • Retrieve a paginated list of quotes
    • Retrieve a quote by ID
  • Task
    • Retrieve a task bundle by ID
    • Retrieve a list of tasks
  • Warehouse
    • Create a new warehouse
    • Retrieve a paginated list of warehouses
    • Update an existing warehouse
    • Retrieve a warehouse by ID
  • Employee
    • Retrieve a paginated list of employees
    • Retrieve an employee by ID
  • Company
    • Retrieve company name by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Delete the registered webhook for the authenticated account.
    • Rotate the HMAC signing secret for the registered webhook.
  1. Invoice

Create or update the invoice on a work order

PUT
/v1/invoices/{invoiceId}
Creates or updates the invoice on a work order and recalculates totals from the submitted items. Send the complete item list each time — this replaces all items, not just the ones that changed.
Required scope: invoices:write

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Invoice saved and totals recalculated successfully.
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🟠409
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://dev.api.fieldedge.com/open-api/v1/invoices/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "transactionDate": "2026-09-07T00:00:00Z",
    "dueDate": "2026-09-21T00:00:00Z",
    "items": [
        {
            "itemId": "e5f6a7b8-c9d0-1234-efab-345678901234",
            "catalogItemId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
            "name": "Service Call",
            "description": "Diagnostic visit",
            "price": 89.99,
            "quantity": 2,
            "salesTaxCodeId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
            "warehouseId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
        }
    ]
}'
Response Response Example
200 - Example invoice response
{
    "invoiceId": "a1b2c3d4-5e6f-47a8-9b0c-d1e2f3a4b5c6",
    "invoiceNumber": "INV-10042",
    "invoiceDate": "2024-06-15T00:00:00.0000000Z",
    "dueDate": "2024-07-15T00:00:00.0000000Z",
    "payStatus": "Due",
    "subtotal": 30,
    "tax": 2.48,
    "total": 32.48,
    "balance": 32.48,
    "salesPersonId": "b2c3d4e5-f6a7-48b9-0c1d-e2f3a4b5c6d7",
    "salesPersonName": "Jane Doe",
    "termsName": "Net 30",
    "taxCodeName": "TX State Tax",
    "departmentName": "Plumbing",
    "billingAddress": {
        "customerId": "b2c3d4e5-f6a7-48b9-0c1d-e2f3a4b5c6d7",
        "customerName": "Acme Corp",
        "name": "John Smith",
        "addressLine1": "456 Oak Ave",
        "addressLine2": "",
        "city": "Austin",
        "state": "TX",
        "postalCode": "78702"
    },
    "items": [
        {
            "itemId": "e5f6a7b8-c9d0-41e2-3f4a-b5c6d7e8f9a0",
            "catalogItemId": "f6a7b8c9-d0e1-42f3-4a5b-c6d7e8f9a0b1",
            "name": "Pipe Installation",
            "description": "Install 1/2-inch copper pipe",
            "quantity": 1,
            "unitPrice": 30,
            "amount": 30,
            "costType": "Labor",
            "itemType": "Assembly",
            "equipmentId": null,
            "equipmentName": null,
            "warehouseId": null,
            "assemblyItems": [
                {
                    "itemId": "c3d4e5f6-a7b8-49c0-1d2e-f3a4b5c6d7e8",
                    "catalogItemId": "d4e5f6a7-b8c9-40d1-2e3f-a4b5c6d7e8f9",
                    "name": "Copper Pipe 1/2\"",
                    "description": "Half-inch copper pipe",
                    "quantity": 2,
                    "unitPrice": 15,
                    "amount": 30,
                    "costType": "Material",
                    "equipmentId": null,
                    "equipmentName": null,
                    "warehouseId": "a7b8c9d0-e1f2-43a4-5b6c-d7e8f9a0b1c2"
                }
            ],
            "flatRateComponents": []
        }
    ]
}
Modified at 2026-10-09 05:36:08
Previous
Retrieve an invoice by ID
Next
Retrieve a paginated list of quotes
Built with