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 customers by phone, email, or first name
      GET
    • Retrieve customer details by ID
      GET
    • Retrieve customers based on address details.
      GET
  • Item Category
    • Retrieve list of item categories
      GET
    • Retrieve item category by id.
      GET
    • Create a new item category
      POST
    • Partially update an item category
      PATCH
  • Item
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Retrieve an inventory item by ID
      GET
    • Creates a new inventory item
      POST
    • Updates an existing inventory item
      PATCH
  • Warehouse
    • Create a new warehouse
      POST
    • Retrieve a paginated list of warehouses
      GET
    • Update an existing warehouse
      PATCH
    • Retrieve a warehouse by ID
      GET
  • Employee
    • Retrieve a paginated list of employees
      GET
    • Retrieve an employee by ID
      GET
  • Company
    • Retrieve company name by ID
      GET
  • WorkOrder
    • Retrieve a work order by ID
  • Invoice
    • Retrieve an invoice by ID
      GET
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Rotate the HMAC signing secret for the registered webhook.
    • Delete the registered webhook for the authenticated account.
  1. Invoice

Retrieve an invoice by ID

GET
/v1/invoices/{invoiceId}
Retrieves the invoice associated with a FieldEdge work order. The invoice ID is the same as the work order ID. Returns 404 if no work order is found or if the work order has no invoice.

Request

Authorization
or
Path Params

Responses

🟢200
application/json
Invoice retrieved successfully
Bodyapplication/json

🟠400
🟠401
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.api.fieldedge.com/open-api/v1/invoices/'
Response Response Example
200 - response
{
    "invoiceId": "a1b2c3d4-5e6f-47a8-9b0c-d1e2f3a4b5c6",
    "invoiceNumber": "INV-10042",
    "invoiceDate": "2024-06-15T00:00:00Z",
    "dueDate": "2024-07-15T00:00:00Z",
    "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,
            "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
                }
            ],
            "flatRateComponents": []
        }
    ]
}
Modified at 2026-05-21 10:40:18
Previous
Retrieve a work order by ID
Next
Register a webhook endpoint to receive event notifications.
Built with