invoice

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/acculynx/json-schema/acculynx-invoice-schema.json",
  "title": "invoice",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/acculynx-api-v2-api-openapi.yml#/components/schemas/invoice",
  "allOf": [
    {
      "$ref": "#/$defs/invoiceLink"
    },
    {
      "type": "object",
      "properties": {
        "jobId": {
          "type": "string",
          "format": "uuid",
          "description": "The unique identifier of the Job this invoice is for."
        },
        "invoiceNumber": {
          "type": "string",
          "description": "The number of the invoice."
        },
        "invoiceSequence": {
          "type": "number",
          "description": "The sequential number assigned to the invoice as its created."
        },
        "invoiceDate": {
          "type": "string",
          "description": "The date/time the invoice in UTC format."
        },
        "dueDate": {
          "type": "string",
          "description": "The due date/time the invoice in UTC format."
        },
        "currentInvoiceState": {
          "type": "string",
          "description": "An identifier that provides an understanding of the state of the invoice.",
          "enum": [
            "Paid",
            "Unpaid",
            "Void",
            "Draft"
          ]
        },
        "totalPrice": {
          "type": "number",
          "description": "The total price of the invoice."
        },
        "balanceDue": {
          "type": "number",
          "description": "The balance due left on the invoice."
        },
        "invoiceName": {
          "type": "string",
          "description": "The user entered name of the invoice."
        },
        "createdDate": {
          "type": "string",
          "description": "The date/time the invoice was created in UTC format."
        },
        "sortIndex": {
          "type": "number",
          "description": "The order the invoice will appear in the list when sorted by invoice sequence."
        },
        "recordingStatus": {
          "type": "string",
          "description": "Status of the invoice integration with external accounting integration."
        },
        "recordingClassification": {
          "type": "string",
          "description": "The user selected classification of the invoice set when recording the invoice."
        },
        "sections": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/invoiceSection"
          }
        }
      }
    }
  ],
  "$defs": {
    "invoiceItem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The unique ID for the item."
        },
        "itemName": {
          "type": "string",
          "description": "The name of the item."
        },
        "price": {
          "type": "number",
          "description": "The user entered price for this item."
        },
        "totalPrice": {
          "type": "number",
          "description": "Represents the contribution to the total of this invoice."
        },
        "parentItemId": {
          "type": "string",
          "description": "The unique ID for the parent item of this item."
        },
        "hierarchySortOrder": {
          "type": "number",
          "description": "The sort order of the item at the nested level it belongs to."
        },
        "lineItemAssignment": {
          "type": "string",
          "description": "The user entered account classification the line was assigned to."
        },
        "referenceId": {
          "type": "string",
          "format": "uuid",
          "description": "The unique ID for the Catalog reference."
        },
        "referenceType": {
          "type": "string",
          "description": "the reference type for the item.",
          "enum": [
            "SKU",
            "Product",
            "CustomeSKU",
            "Labor",
            "SKUAndLabor"
          ]
        },
        "tradeId": {
          "type": "string",
          "format": "uuid",
          "description": "The unique ID for the trade of this item."
        }
      }
    },
    "invoiceLink": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The unique identifier of the invoice."
        },
        "_link": {
          "type": "string",
          "description": "The unique URI of the invoice for the specified Job."
        }
      }
    },
    "invoiceSection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The unique ID for the invoice section."
        },
        "invoiceWorksheetSectionType": {
          "type": "string",
          "description": "An identifier for the type of invoice worksheet section.",
          "enum": [
            "Invoice",
            "Work Not Doing",
            "Supplements",
            "Discounts",
            "Upgrades",
            "Change Order",
            "Financial Worksheet",
            "Insurance Claim"
          ]
        },
        "totalPrice": {
          "type": "number",
          "description": "The total price of this invoice worksheet section."
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/invoiceItem"
          }
        }
      }
    }
  }
}