New KPMG Agentic ERP, now available with KPMG in 140+ countries Read the announcement

API/Reference/Customers

Update customer

PATCH 
https://api.light.inc/v1/customers/{customerId}

Updates an existing customer

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

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

  • Bearer token

Path parameters

  • customerId string · uuidrequired

Headers

  • X-Idempotency-Key string

Request body

application/json;charset=UTF-8

  • name string

  • email string

  • address object

    • country string

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

      One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

      Note

      City.

    • state string

      Note

      State or region, where the country uses one.

    • zipcode string

      Note

      Postal code.

    • street string

      Note

      First address line.

    • street2 string

      Note

      Second address line.

  • billingAddress object

    • country string

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

      One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

      Note

      City.

    • state string

      Note

      State or region, where the country uses one.

    • zipcode string

      Note

      Postal code.

    • street string

      Note

      First address line.

    • street2 string

      Note

      Second address line.

  • customProperties array of object

    • groupId string · uuid

      ID of the custom property group.

    • valueIds array of string · uuid

      IDs of the selected custom property values. It behaves as a PUT operation, so if empty the existing ones will be effectively deleted.

      Note

      Catalogue value ids for this group. Required; send [] (with an empty inlineValues) to clear the group. SINGLE_SELECT and MULTI_SELECT groups accept nothing else. See Custom properties on writes.

    • inlineValues array of string

      Inline custom property values (used for TEXT/NUMERIC/DATE/etc. groups). It behaves as a PUT operation, so if empty or null the existing ones will be effectively deleted.

      Note

      Literal values for TEXT, NUMERIC, BOOLEAN and DATE groups, as strings (yyyy-MM-dd for dates). Rejected on select groups with CUSTOM_PROPERTY_VALUE_TYPE_MISMATCH. See Custom properties on writes.

  • shippingAddress object

    • country string

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

      One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

      Note

      City.

    • state string

      Note

      State or region, where the country uses one.

    • zipcode string

      Note

      Postal code.

    • street string

      Note

      First address line.

    • street2 string

      Note

      Second address line.

  • domain string

  • description string

  • vatNumber string

  • businessRegistrationNumber string

  • easCode string

  • einvoiceAddress string

  • einvoiceNetwork string

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

    One of FINVOICE FR_PA MYDATA NEMHANDEL PEPPOL PORTUGUESE_TAX_REPORTING SDI VERIFACTU

  • type string

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

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

    One of BUSINESS CONSUMER GOVERNMENT

  • defaultTaxId string · uuid

    Default tax code ID. Must be an active sales tax. Omit to leave unchanged; send null to clear. Saving this preference does not change existing invoice or contract lines.

  • logoUrl string

  • recipientEmails array of string

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

  • ccEmails array of string

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

  • externalSource object

    The customer's ID in an external system and the system it comes from. Rejected when another customer already has the same ID from the same system.

    • name string

      The system the ID comes from

      • HUBSPOT - Customer from HubSpot
      • SALESFORCE - Customer from Salesforce
      • STRIPE - Customer from Stripe

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

      One of HUBSPOT SALESFORCE STRIPE

    • externalId string

      The ID of the customer in the external system

Response

  • id string · uuid

    Unique identifier for the object

  • name string

    Name of the customer

  • email string

    Email address of the customer

  • address object

    Note

    Deprecated alias of billingAddress: the two are one value.

    • country string

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

      One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

      Note

      City.

    • state string

      Note

      State or region, where the country uses one.

    • zipcode string

      Note

      Postal code.

    • street string

      Note

      First address line.

    • street2 string

      Note

      Second address line.

  • billingAddress object

    Note

    The address printed on invoices.

    • country string

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

      One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

      Note

      City.

    • state string

      Note

      State or region, where the country uses one.

    • zipcode string

      Note

      Postal code.

    • street string

      Note

      First address line.

    • street2 string

      Note

      Second address line.

  • shippingAddress object

    Note

    Delivery address, when different from the billing address.

    • country string

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

      One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

    • city string

      Note

      City.

    • state string

      Note

      State or region, where the country uses one.

    • zipcode string

      Note

      Postal code.

    • street string

      Note

      First address line.

    • street2 string

      Note

      Second address line.

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

    One of ACTIVE ARCHIVED

  • description string

    Description or notes about the customer

  • vatNumber string

    VAT number of the customer

  • businessRegistrationNumber string

    Business registration number of the customer

  • easCode string

    Electronic Address Scheme code used for sending e-invoices

  • einvoiceAddress string

    E-invoice address for the customer

  • einvoiceNetwork string

    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.

    One of FINVOICE FR_PA MYDATA NEMHANDEL PEPPOL PORTUGUESE_TAX_REPORTING SDI VERIFACTU

  • type string

    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.

    One of BUSINESS CONSUMER GOVERNMENT

  • representedCompanyEntityId string · uuid

    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.

  • defaultTaxId string · uuid

    Stored default tax code ID for the customer

  • logoUrl string

    URL to the customer's logo

  • domain string

    Domain of the customer's website

  • externalSource object

    The external system where this product was synced from

    Note

    Set when the customer was imported from another system: the system's name and the customer's id there.

    • name string

      The name of the external source

      • CHARGEBEE - Data synced from Chargebee
      • HUBSPOT - Data synced from HubSpot
      • SALESFORCE - Data synced from Salesforce
      • STRIPE - Data synced from Stripe

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

      One of CHARGEBEE HUBSPOT SALESFORCE STRIPE

    • externalId string

      The ID of the object in the external source system

  • createdAt string · date-time

    Timestamp when the customer was created

  • updatedAt string · date-time

    Timestamp when the customer was last updated

  • customProperties array of object

    List of custom properties associated with the customer

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • values array of object

      List of values. Note that this will be a single value unless the group input type supports multiple values

      • id string · uuid

        Unique identifier for the object

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • companyId string · uuid

        ID of the company

      • internalName string

        Internal name of the custom property value

      • label string

        Label of the custom property value

      • context string

        Context/description of the custom property value

      • createdAt string · date-time

        Timestamp when the custom property value was created

      • updatedAt string · date-time

        Timestamp when the custom property value was last updated

  • recipientEmails array of string

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

  • ccEmails array of string

    Billing email CC recipients used when sending invoices to this customer