MatchesPage

matches object[]

Array [

documentIDstring<uuid>

PO ID (when matching invoice→PO) or Invoice ID (when matching PO→invoice)

lineItem object

Line item data returned when querying matches for PO or Invoice lines.

idstring<uuid>

lineSequenceNumberinteger

productCodestringnullable

descriptionstringnullable

quantitynumbernullable

amountExclTaxnumbernullable

amountInclTaxnumbernullable

taxAmountnumbernullable

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

glCode object

A GL code summary (as returned in matching line item responses).

idstring<uuid>nullable

The Lightyear ID for this GL code.

codestringnullable

The GL code identifier.

descriptionstringnullable

The GL code description.

sourceIDstringnullable

The unique identifier for this object in the source system.

categories object[]

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]

]

additionalInfostringnullable

matchingClosedboolean

typestring

Possible values: [CONFIRMED]

]

pageNointeger

totalCountinteger

MatchesPage

{
  "matches": [
    {
      "documentID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "lineItem": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "lineSequenceNumber": 0,
        "productCode": "string",
        "description": "string",
        "quantity": 0,
        "amountExclTax": 0,
        "amountInclTax": 0,
        "taxAmount": 0,
        "taxCode": {
          "id": "79f53980-7f6b-4d18-ac38-48b60d399e1e",
          "code": "TAX-001",
          "description": "string",
          "sourceID": "TAX-001",
          "ratePercent": 20
        },
        "glCode": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "code": "string",
          "description": "string",
          "sourceID": "string"
        },
        "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",
        "matchingClosed": true
      },
      "type": "CONFIRMED"
    }
  ],
  "pageNo": 0,
  "totalCount": 0
}