Skip to main content
PATCH
/
v1
/
customers
/
{customerId}
Update customer
curl --request PATCH \
  --url https://api.light.inc/v1/customers/{customerId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "address": {
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "street": "<string>",
    "street2": "<string>"
  },
  "billingAddress": {
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "street": "<string>",
    "street2": "<string>"
  },
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "valueIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "inlineValues": [
        "<string>"
      ]
    }
  ],
  "shippingAddress": {
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "street": "<string>",
    "street2": "<string>"
  },
  "domain": "<string>",
  "description": "<string>",
  "vatNumber": "<string>",
  "businessRegistrationNumber": "<string>",
  "easCode": "<string>",
  "einvoiceAddress": "<string>",
  "logoUrl": "<string>",
  "recipientEmails": [
    "<string>"
  ],
  "ccEmails": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "email": "<string>",
  "address": {
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "street": "<string>",
    "street2": "<string>"
  },
  "billingAddress": {
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "street": "<string>",
    "street2": "<string>"
  },
  "shippingAddress": {
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "street": "<string>",
    "street2": "<string>"
  },
  "description": "<string>",
  "vatNumber": "<string>",
  "businessRegistrationNumber": "<string>",
  "easCode": "<string>",
  "einvoiceAddress": "<string>",
  "logoUrl": "<string>",
  "domain": "<string>",
  "externalSource": {
    "externalId": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupInternalName": "<string>",
      "values": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "internalName": "<string>",
          "label": "<string>",
          "context": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "recipientEmails": [
    "<string>"
  ],
  "ccEmails": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Headers

​
X-Idempotency-Key
string

Path Parameters

​
customerId
string<uuid>
required

Body

application/json;charset=UTF-8
​
name
string | null
​
email
string | null
​
address
object
​
billingAddress
object
​
customProperties
(object | null)[] | null

List of custom properties to set on the vendor. Replaces the existing set.

​
shippingAddress
object
​
domain
string | null
​
description
string | null
​
vatNumber
string | null
​
businessRegistrationNumber
string | null
​
easCode
string | null
​
einvoiceAddress
string | null
​
einvoiceNetwork
enum<string> | null
  • 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.

Available options:
MYDATA,
NEMHANDEL,
PEPPOL,
PORTUGUESE_TAX_REPORTING,
SDI,
VERIFACTU
​
type
enum<string> | null
  • BUSINESS - Business customer
  • CONSUMER - Consumer customer
  • GOVERNMENT - Government customer

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

Available options:
BUSINESS,
CONSUMER,
GOVERNMENT
​
logoUrl
string | null
​
recipientEmails
(string | null)[] | null

Billing email recipients ("Send to"). Omit to leave unchanged; send an empty list to clear.

Billing email recipients ("Send to"). Omit to leave unchanged; send an empty list to clear.

​
ccEmails
(string | null)[] | null

Billing email CC recipients. Omit to leave unchanged; send an empty list to clear.

Billing email CC recipients. Omit to leave unchanged; send an empty list to clear.

Response

default - application/json;charset=UTF-8

default response

​
id
string<uuid>

Unique identifier for the object

​
name
string

Name of the customer

​
email
string | null

Email address of the customer

​
address
object
​
billingAddress
object
​
shippingAddress
object
​
status
enum<string>

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.

Available options:
ACTIVE,
ARCHIVED
​
description
string | null

Description or notes about the customer

​
vatNumber
string | null

VAT number of the customer

​
businessRegistrationNumber
string | null

Business registration number of the customer

​
easCode
string | null

Electronic Address Scheme code used for sending e-invoices

​
einvoiceAddress
string | null

E-invoice address for the customer

​
einvoiceNetwork
enum<string> | null

E-invoice network the customer is registered on

  • 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.

Available options:
MYDATA,
NEMHANDEL,
PEPPOL,
PORTUGUESE_TAX_REPORTING,
SDI,
VERIFACTU
​
type
enum<string> | null

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.

Available options:
BUSINESS,
CONSUMER,
GOVERNMENT
​
logoUrl
string | null

URL to the customer's logo

​
domain
string | null

Domain of the customer's website

​
externalSource
object | null

The external system where this product was synced from

​
createdAt
string<date-time>

Timestamp when the customer was created

​
updatedAt
string<date-time>

Timestamp when the customer was last updated

​
customProperties
(object | null)[] | null

List of custom properties associated with the customer

Custom properties set on the vendor.

​
recipientEmails
string[]

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

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

​
ccEmails
string[]

Billing email CC recipients used when sending invoices to this customer

Billing email CC recipients used when sending invoices to this customer