LIlight
v1 - Customers

Create customer

Creates a new customer

post/v1/customers

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Headers

X-Idempotency-Keystring

Request body

namestring
emailstring nullable
domainstring nullable
descriptionstring nullable
vatNumberstring nullable
businessRegistrationNumberstring nullable
easCodestring nullable
einvoiceAddressstring nullable
einvoiceNetwork'FINVOICE' | 'FR_PA' | 'MYDATA' | 'NEMHANDEL' | 'PEPPOL' | 'PORTUGUESE_TAX_REPORTING' | 'SDI' | 'VERIFACTU' nullable
  • FINVOICE - Finland Finvoice e-invoice network
  • FR_PA - France Plateforme Agréée (Chorus Pro / Annuaire) e-invoice network
  • MYDATA - Greece myDATA e-invoice network
  • NEMHANDEL - NemHandel e-invoice network
  • PEPPOL - Peppol e-invoice network
  • PORTUGUESE_TAX_REPORTING - Portuguese tax reporting (ATCUD) e-invoice network
  • SDI - SDI (Sistema di Interscambio) e-invoice network
  • VERIFACTU - Spain VERI*FACTU tax reporting e-invoice network

⚠️ This enum is not exhaustive; new values may be added in the future.

type'BUSINESS' | 'CONSUMER' | 'GOVERNMENT' nullable
  • BUSINESS - Business customer
  • CONSUMER - Consumer customer
  • GOVERNMENT - Government customer

⚠️ This enum is not exhaustive; new values may be added in the future.

defaultTaxIdstring uuid nullable

ID of an active sales tax code to store as the customer's default. Saving this preference does not change existing invoice or contract lines.

logoUrlstring nullable
recipientEmailsstring[] nullable

Billing email recipients ("Send to") used when sending invoices to this customer

ccEmailsstring[] nullable

Billing email CC recipients used when sending invoices to this customer

Response

default response

idstring uuid

Unique identifier for the object

namestring

Name of the customer

emailstring nullable

Email address of the customer

status'ACTIVE' | 'ARCHIVED'

Current status of the customer

  • ACTIVE - The customer is active and can be used in invoices and contracts
  • ARCHIVED - The customer is archived and cannot be used in new invoices or contracts

⚠️ This enum is not exhaustive; new values may be added in the future.

descriptionstring nullable

Description or notes about the customer

vatNumberstring nullable

VAT number of the customer

businessRegistrationNumberstring nullable

Business registration number of the customer

easCodestring nullable

Electronic Address Scheme code used for sending e-invoices

einvoiceAddressstring nullable

E-invoice address for the customer

einvoiceNetwork'FINVOICE' | 'FR_PA' | 'MYDATA' | 'NEMHANDEL' | 'PEPPOL' | 'PORTUGUESE_TAX_REPORTING' | 'SDI' | 'VERIFACTU' nullable

E-invoice network the customer is registered on

  • FINVOICE - Finland Finvoice e-invoice network
  • FR_PA - France Plateforme Agréée (Chorus Pro / Annuaire) e-invoice network
  • MYDATA - Greece myDATA e-invoice network
  • NEMHANDEL - NemHandel e-invoice network
  • PEPPOL - Peppol e-invoice network
  • PORTUGUESE_TAX_REPORTING - Portuguese tax reporting (ATCUD) e-invoice network
  • SDI - SDI (Sistema di Interscambio) e-invoice network
  • VERIFACTU - Spain VERI*FACTU tax reporting e-invoice network

⚠️ This enum is not exhaustive; new values may be added in the future.

type'BUSINESS' | 'CONSUMER' | 'GOVERNMENT' nullable

Type of customer

  • BUSINESS - Business customer
  • CONSUMER - Consumer customer
  • GOVERNMENT - Government customer

⚠️ This enum is not exhaustive; new values may be added in the future.

representedCompanyEntityIdstring uuid nullable

ID of the company entity this business partner represents. Set when Light creates the partner for intercompany invoicing, or when a user links an existing one; null for ordinary customers.

defaultTaxIdstring uuid nullable

Stored default tax code ID for the customer

logoUrlstring nullable

URL to the customer's logo

domainstring nullable

Domain of the customer's website

createdAtstring date-time

Timestamp when the customer was created

updatedAtstring date-time

Timestamp when the customer was last updated

recipientEmailsstring[]

Billing email recipients ("Send to") used when sending invoices to this customer

ccEmailsstring[]

Billing email CC recipients used when sending invoices to this customer

Changes

No recorded changes to this operation across all 1 revision of this API.