Invoice

An invoice.

idstring

The invoice's unique ID.

Example: 9ceef160-4388-4389-a658-96511c9b278d

companyIDstring

The ID of the Lightyear company that owns this invoice.

Example: 93913d26-427e-4798-8e1f-06c83411113c

fileNamestringnullable

The original file name of the ingested document.

Example: Invoice 12345.pdf

invoiceTypestring

The type of invoice. Possible values are:

EXPENSE: An expense document
LINEITEMS: An invoice with the original line items
LINEITEMSCRNOTE: A credit note with the original line items
RECEIPT: A receipt
SERVICE: An invoice with the original line items replaced with line items derived from the document totals
SERVICECRNOTE: A credit note with the original line items replaced with line items derived from the document totals

Possible values: [Expense, LineItems, LineItemsCrNote, Receipt, Service, ServiceCrNote]

Example: Service

invoiceNumberstring

The invoice number.

Example: INV-12345

invoiceDatestring<date-time>

The ISO formatted invoice date in the companies timezone e.g. 2024-05-14T00:00:00+01:00

Example: 2024-05-14T00:00:00+01:00

subTotalnumber

The sub-total.

Example: 123.45

calculatedTaxnumber

The tax.

Example: 24.69

currencyCodestring

The 3 letter ISO currency code for the amounts in this invoice.

Example: GBP

additionalInfostringnullable

Additional information.

Example: Some additional information about this invoice

purchaseOrderNumberstringnullable

The purchase order number associated with the invoice.

Example: PO-12345

supplierCard object

A supplier card.

sourceIDstring

The unique identifier for this object in the source system.

Example: SUP-001

codestringnullable

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

Example: SUP-001

fullNamestring

The supplier name.

Example: ACME

taxNumberstringnullable

The supplier's tax number.

Example: GB123456789

countryCodestringnullable

The supplier's 2 letter ISO country code.

Example: GB

currencystringnullable

The supplier's 3 letter ISO currency code.

Example: GBP

bankAccount object

Bank account details.

accountNamestringnullable

Account name.

accountNumberstringnullable

Account number.

sortCodestringnullable

Sort code.

bicstringnullable

Bank identification number.

ibanstringnullable

International bank account number.

address object

An address

line1stringnullable

Example: 124 ACME Road

line2stringnullable

Example: Southgate

line3stringnullable

Example: London

line4stringnullable

Example: England

line5stringnullable

Example: RR12 8QA

salesOrder object

A sales order.

address object

An address

line1stringnullable

Example: 124 ACME Road

line2stringnullable

Example: Southgate

line3stringnullable

Example: London

line4stringnullable

Example: England

line5stringnullable

Example: RR12 8QA

contactMobileNumberstringnullable

Sales order contact mobile number.

Example: 020 7371 9918

contactPhoneNumberstringnullable

Sales order contact phone number.

Example: 020 7371 9919

countystringnullable

Sales order county

Example: County

deliveryDateFromstring<date-time>

The ISO formatted delivery date from in the companies timezone e.g. 2024-05-14T00:00:00+01:00

Example: 2024-05-14T00:00:00+01:00

deliveryDateTostring<date-time>

The ISO formatted delivery date to in the companies timezone e.g. 2024-05-14T00:00:00+01:00

Example: 2024-05-14T00:00:00+01:00

deliveryInstructionsstringnullable

Sales order delivery instructions.

Example: Leave with neighbour

postcodestringnullable

Sales order post code

Example: RR12 8QA

townstringnullable

Sales order town

Example: Southgate

glCode object

A general ledger code.

idstringnullable

The Lightyear ID for this object. When importing the object this field should be null, omitted or the default value 00000000-0000-0000-0000-000000000000

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 arounding 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[]

Invoice categories.

Array [

idstringnullable

The Lightyear ID for this object. When importing the object this field should be null, omitted or the default value 00000000-0000-0000-0000-000000000000

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]

]

lineItems object[]

The invoice line items.

Array [

idstring

The line item's unique ID.

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

productCodestringnullable

The product code.

taxCode object

A tax code.

idstringnullable

The Lightyear ID for this object. When importing the object this field should be null, omitted or the default value 00000000-0000-0000-0000-000000000000

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.

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 null, omitted or the default value 00000000-0000-0000-0000-000000000000

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 arounding 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 null, omitted or the default value 00000000-0000-0000-0000-000000000000

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]

]

additionalInfostringnullable

Additional information associated with the line item.

]

Invoice
{
  "id": "9ceef160-4388-4389-a658-96511c9b278d",
  "companyID": "93913d26-427e-4798-8e1f-06c83411113c",
  "fileName": "Invoice 12345.pdf",
  "invoiceType": "Service",
  "invoiceNumber": "INV-12345",
  "invoiceDate": "2024-05-14T00:00:00+01:00",
  "subTotal": 123.45,
  "calculatedTax": 24.69,
  "currencyCode": "GBP",
  "additionalInfo": "Some additional information about this invoice",
  "purchaseOrderNumber": "PO-12345",
  "supplierCard": {
    "sourceID": "SUP-001",
    "code": "SUP-001",
    "fullName": "ACME",
    "taxNumber": "GB123456789",
    "countryCode": "GB",
    "currency": "GBP",
    "bankAccount": {
      "accountName": "string",
      "accountNumber": "string",
      "sortCode": "string",
      "bic": "string",
      "iban": "string"
    },
    "address": {
      "line1": "124 ACME Road",
      "line2": "Southgate",
      "line3": "London",
      "line4": "England",
      "line5": "RR12 8QA"
    }
  },
  "salesOrder": {
    "address": {
      "line1": "124 ACME Road",
      "line2": "Southgate",
      "line3": "London",
      "line4": "England",
      "line5": "RR12 8QA"
    },
    "contactMobileNumber": "020 7371 9918",
    "contactPhoneNumber": "020 7371 9919",
    "county": "County",
    "deliveryDateFrom": "2024-05-14T00:00:00+01:00",
    "deliveryDateTo": "2024-05-14T00:00:00+01:00",
    "deliveryInstructions": "Leave with neighbour",
    "postcode": "RR12 8QA",
    "town": "Southgate"
  },
  "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"
    }
  ],
  "lineItems": [
    {
      "id": "12443a52-9418-49a9-957c-67688e28c8a8",
      "productCode": "string",
      "taxCode": {
        "id": "79f53980-7f6b-4d18-ac38-48b60d399e1e",
        "code": "TAX-001",
        "description": "string",
        "sourceID": "TAX-001",
        "ratePercent": 20
      },
      "quantity": 0,
      "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"
        }
      ],
      "additionalInfo": "string"
    }
  ]
}