Skip to main content

LineItem

An invoice line item.

idstring

The line item's unique ID.

Example: 12443a52-9418-49a9-957c-67688e28c8a8
lineItemNumberinteger

The line item number.

productCodestringnullable

The product code.

taxCode object

A tax code.

idstringnullable

The Lightyear ID for this object.

When importing the object this field should be omitted or null.

Example: 79f53980-7f6b-4d18-ac38-48b60d399e1e
codestringnullable

The object code identifier.

Usually this will be a human readable value for the object being imported.

Example: TAX-001
descriptionstring

The description of the object being imported.

sourceIDstring

The unique identifier for this object in the source system.

Example: TAX-001
ratePercentnumber

The tax rate percent associated with the tax code.

Example: 20
quantitynumbernullable

The quantity.

Example: 1
amountExclTaxnumber

The line amount excluding tax.

Example: 123.34
taxAmountnumber

The tax on the line amount.

Example: 24.69
amountInclTaxnumber

The line amount including tax.

Example: 148.14
descriptionstring

The line item description.

Example: Goods / Services (Taxable)
glCode object

A general ledger code.

idstringnullable

The Lightyear ID for this object.

When importing the object this field should be omitted or null.

Example: 79f53980-7f6b-4d18-ac38-48b60d399e1e
codestringnullable

The object code identifier.

Usually this will be a human readable value for the object being imported.

Example: CODE-001
descriptionstring

The description of the object being imported.

glTypestringnullable

The type of the GL code.

isRoundingCodeboolean

Indicates if this GL code is a rounding GL code.

When importing the object this field can be omitted in which case the default is false.

isHeaderGLCodeboolean

Indicates if this GL code is a header GL code.

When importing the object this field can be omitted in which case the default is false.

isSourceInUseboolean

Indicates if this GL code is in-use/active in the source system.

sourceIDstring

The unique identifier for this object in the source system.

Example: CODE-001
categories object[]

Line item categories.

  • Array [
    • idstringnullable

    The Lightyear ID for this object.

    When importing the object this field should be omitted or null.

    Example: 79f53980-7f6b-4d18-ac38-48b60d399e1e
    parentIDstringnullable

    The Lightyear ID for the parent category of this category.

    Example: 2fc2db4c-5415-454b-ae0d-733e83e9de9a
    codestringnullable

    The object code identifier.

    Usually this will be a human readable value for the object being imported.

    Example: CAT-001
    descriptionstring

    The description of the object being imported.

    sourceIDstring

    The unique identifier for this object in the source system.

    Example: CAT-001
    parentSourceIDstringnullable

    The unique identifier for the the parent of the object in the source system if one exists.

    sequenceintegernullable

    The sequence if the categories are ordered.

    This can be omitted on import in which case a default value of 0 will be assigned.

    inUsebooleannullable

    Indicates if the category is in-use in the source system.

    This can be omitted on import in which case a default vlaue of true will be assigned.

    typestring

    The category type.

    Possible values: [BRANCH, CATEGORY, CLASSIFICATION, CUSTOMER, DEPARTMENT, FIXED_ASSET, INVENTORY, ITEM, JOB, LOCATION, PROJECT]

  • ]
    • netWeightnumbernullable

    Net weight of the line item

    Example: 12.5
    lineTotalDiscountsnumbernullable

    Total discounts applied to the line item

    Example: 5
    additionalInfostringnullable

    Additional information associated with the line item.

    unitPriceInclTaxnumbernullable

    The unit price including tax.

    unitPriceExclTaxnumbernullable

    The unit price excluding tax.

    selectedForInventoryboolean

    Whether this line item is selected for inventory.

    inventoryUnitTypestringnullable

    The inventory unit type.

    posCodestringnullable

    The POS code.

    caseQuantitynumbernullable

    The case quantity.

    LineItem
    {
      "id": "12443a52-9418-49a9-957c-67688e28c8a8",
      "lineItemNumber": 0,
      "productCode": "string",
      "taxCode": {
        "id": "79f53980-7f6b-4d18-ac38-48b60d399e1e",
        "code": "TAX-001",
        "description": "string",
        "sourceID": "TAX-001",
        "ratePercent": 20
      },
      "quantity": 1,
      "amountExclTax": 123.34,
      "taxAmount": 24.69,
      "amountInclTax": 148.14,
      "description": "Goods / Services (Taxable)",
      "glCode": {
        "id": "79f53980-7f6b-4d18-ac38-48b60d399e1e",
        "code": "CODE-001",
        "description": "string",
        "glType": "string",
        "isRoundingCode": true,
        "isHeaderGLCode": true,
        "isSourceInUse": true,
        "sourceID": "CODE-001"
      },
      "categories": [
        {
          "id": "79f53980-7f6b-4d18-ac38-48b60d399e1e",
          "parentID": "2fc2db4c-5415-454b-ae0d-733e83e9de9a",
          "code": "CAT-001",
          "description": "string",
          "sourceID": "CAT-001",
          "parentSourceID": "string",
          "sequence": 0,
          "inUse": true,
          "type": "BRANCH"
        }
      ],
      "netWeight": 12.5,
      "lineTotalDiscounts": 5,
      "additionalInfo": "string",
      "unitPriceInclTax": 0,
      "unitPriceExclTax": 0,
      "selectedForInventory": true,
      "inventoryUnitType": "string",
      "posCode": "string",
      "caseQuantity": 0
    }