Skip to main content

SupplierCard

A supplier card.

idstringnullable

The Lightyear ID for this object.

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

Example: 79f53980-7f6b-4d18-ac38-48b60d399e1e
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

Note the supplier address fields are limited to 50 characters.

line1stringnullable

Address line 1

Example: 124 ACME Road
line2stringnullable

Address line 2

Example: Southgate
line3stringnullable

Town/City

Example: London
line4stringnullable

County

Example: England
line5stringnullable

Postcode

Example: RR12 8QA
terms objectnullable

The supplier payment terms.

termsTypestringnullable

The type of payment terms. Possible values:

  • DO_NOT_POPULATE: Terms will not be set on the supplier. termsDays not used.
  • DUE_ON_RECEIPT: Payment due immediately. termsDays not used (null).
  • FROM_BILL_DATE: Due X days from the invoice/bill date. termsDays required.
  • FROM_END_OF_MONTH: Due X days after end of month. termsDays required.
  • LAST_DAY_OF_MONTH: Due on the last calendar day of the month. termsDays not used.
  • LAST_WORKING_DAY_OF_MONTH: Due on the last working day of the month. termsDays not used.
  • USE_EXTRACTED_DUE_DATE: Uses the due date extracted from the invoice. termsDays not used (null). Default fallback if termsType is null.

Possible values: [DO_NOT_POPULATE, DUE_ON_RECEIPT, FROM_BILL_DATE, FROM_END_OF_MONTH, LAST_DAY_OF_MONTH, LAST_WORKING_DAY_OF_MONTH, USE_EXTRACTED_DUE_DATE]

Example: FROM_BILL_DATE
termsDaysintegernullable

The number of days for the payment terms. Only applicable when termsType is FROM_BILL_DATE or FROM_END_OF_MONTH, null otherwise.

Example: 30
SupplierCard
{
  "id": "79f53980-7f6b-4d18-ac38-48b60d399e1e",
  "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"
  },
  "terms": {
    "termsType": "FROM_BILL_DATE",
    "termsDays": 30
  }
}