The customer object

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "sequential_id": 1,
  "slug": "LAG-1234-001",
  "external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
  "billing_entity_code": "acme_corp",
  "address_line1": "5230 Penfield Ave",
  "address_line2": null,
  "applicable_timezone": "America/Los_Angeles",
  "city": "Woodland Hills",
  "country": "US",
  "currency": "USD",
  "email": "dinesh@piedpiper.example",
  "legal_name": "Coleman-Blair",
  "legal_number": "49-008-2965",
  "logo_url": "http://hooli.com/logo.png",
  "name": "Gavin Belson",
  "firstname": "Gavin",
  "lastname": "Belson",
  "account_type": "customer",
  "customer_type": "company",
  "phone": "1-171-883-3711 x245",
  "state": "CA",
  "tax_identification_number": "EU123456789",
  "timezone": "America/Los_Angeles",
  "url": "http://hooli.com",
  "zipcode": "91364",
  "net_payment_term": 30,
  "external_salesforce_id": "0015p00001JQx1QAAT",
  "created_at": "2022-04-29T08:59:51Z",
  "updated_at": "2022-04-29T08:59:51Z",
  "finalize_zero_amount_invoice": "inherit",
  "skip_invoice_custom_sections": false,
  "billing_configuration": {
    "invoice_grace_period": 3,
    "subscription_invoice_issuing_date_anchor": "next_period_start",
    "subscription_invoice_issuing_date_adjustment": "keep_anchor",
    "payment_provider": "stripe",
    "payment_provider_code": "stripe-eu-1",
    "provider_customer_id": "cus_12345",
    "sync": true,
    "sync_with_provider": true,
    "document_locale": "fr",
    "provider_payment_methods": [
      "card",
      "sepa_debit",
      "us_bank_account",
      "bacs_debit",
      "link",
      "boleto",
      "crypto",
      "customer_balance"
    ]
  },
  "shipping_address": {
    "address_line1": "5230 Penfield Ave",
    "address_line2": null,
    "city": "Woodland Hills",
    "country": "US",
    "state": "CA",
    "zipcode": "91364"
  },
  "metadata": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "key": "Purchase Order",
      "value": "123456789",
      "display_in_invoice": true,
      "created_at": "2022-04-29T08:59:51Z"
    }
  ],
  "integration_customers": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "type": "netsuite",
      "integration_code": "netsuite-eu-1",
      "code": "netsuite-eu-1",
      "is_default": true,
      "category": "accounting",
      "external_customer_id": "cus_12345",
      "sync_with_provider": true,
      "subsidiary_id": "2",
      "targeted_object": "contacts",
      "email": "dinesh@piedpiper.example"
    }
  ],
  "taxes": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "name": "TVA",
      "code": "french_standard_vat",
      "description": "French standard VAT",
      "rate": 20,
      "applied_to_organization": true,
      "created_at": "2023-07-06T14:35:58Z",
      "applied_to_billing_entities_codes": [
        "acme_corp",
        "foo_bar"
      ]
    }
  ],
  "applicable_invoice_custom_sections": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "name": "EU Bank Details",
      "code": "eu_bank_details",
      "description": "This section contains the bank details for EU customers.",
      "details": "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143",
      "display_name": "Bank Details:",
      "applied_to_organization": true,
      "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2023-07-06T14:35:58Z"
    }
  ],
  "error_details": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "error_code": "tax_error",
      "details": {
        "tax_error": "taxDateTooFarInFuture"
      }
    }
  ]
}

lago_id

string<uuid>

required

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

sequential_id

integer

required

The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct sequential_id associated with them, allowing for easy identification and sorting based on the order of creation

Example:

1

slug

string

required

A concise and unique identifier for the customer, formed by combining the Organization's name, id, and customer's sequential_id

Example:

"LAG-1234-001"

external_id

string

required

The customer external unique identifier (provided by your own application)

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

billing_entity_code

string

required

The unique code of the billing entity associated with the customer.

Example:

"acme_corp"

address_line1

string | null

required

The first line of the billing address

Example:

"5230 Penfield Ave"

address_line2

string | null

required

The second line of the billing address

Example:

null

applicable_timezone

enum<string>

required

The customer's applicable timezone, used for billing purposes in their local time.

Available options:

UTC,

Africa/Algiers,

Africa/Cairo,

Africa/Casablanca,

Africa/Harare,

Africa/Johannesburg,

Africa/Monrovia,

Africa/Nairobi,

America/Argentina/Buenos_Aires,

America/Bogota,

America/Caracas,

America/Chicago,

America/Chihuahua,

America/Denver,

America/Guatemala,

America/Guyana,

America/Halifax,

America/Indiana/Indianapolis,

America/Juneau,

America/La_Paz,

America/Lima,

America/Los_Angeles,

America/Mazatlan,

America/Mexico_City,

America/Monterrey,

America/Montevideo,

America/New_York,

America/Nuuk,

America/Phoenix,

America/Puerto_Rico,

America/Regina,

America/Santiago,

America/Sao_Paulo,

America/St_Johns,

America/Tijuana,

Asia/Almaty,

Asia/Baghdad,

Asia/Baku,

Asia/Bangkok,

Asia/Chongqing,

Asia/Colombo,

Asia/Dhaka,

Asia/Hong_Kong,

Asia/Irkutsk,

Asia/Jakarta,

Asia/Jerusalem,

Asia/Kabul,

Asia/Kamchatka,

Asia/Karachi,

Asia/Kathmandu,

Asia/Kolkata,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuwait,

Asia/Magadan,

Asia/Muscat,

Asia/Novosibirsk,

Asia/Riyadh,

Asia/Seoul,

Asia/Shanghai,

Asia/Singapore,

Asia/Srednekolymsk,

Asia/Taipei,

Asia/Tashkent,

Asia/Tbilisi,

Asia/Tehran,

Asia/Tokyo,

Asia/Ulaanbaatar,

Asia/Urumqi,

Asia/Vladivostok,

Asia/Yakutsk,

Asia/Yangon,

Asia/Yekaterinburg,

Asia/Yerevan,

Atlantic/Azores,

Atlantic/Cape_Verde,

Atlantic/South_Georgia,

Australia/Adelaide,

Australia/Brisbane,

Australia/Darwin,

Australia/Hobart,

Australia/Melbourne,

Australia/Perth,

Australia/Sydney,

Europe/Amsterdam,

Europe/Athens,

Europe/Belgrade,

Europe/Berlin,

Europe/Bratislava,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

Europe/Copenhagen,

Europe/Dublin,

Europe/Helsinki,

Europe/Istanbul,

Europe/Kaliningrad,

Europe/Kyiv,

Europe/Lisbon,

Europe/Ljubljana,

Europe/London,

Europe/Madrid,

Europe/Minsk,

Europe/Moscow,

Europe/Paris,

Europe/Prague,

Europe/Riga,

Europe/Rome,

Europe/Samara,

Europe/Sarajevo,

Europe/Skopje,

Europe/Sofia,

Europe/Stockholm,

Europe/Tallinn,

Europe/Vienna,

Europe/Vilnius,

Europe/Volgograd,

Europe/Warsaw,

Europe/Zagreb,

Europe/Zurich,

GMT+12,

Pacific/Apia,

Pacific/Auckland,

Pacific/Chatham,

Pacific/Fakaofo,

Pacific/Fiji,

Pacific/Guadalcanal,

Pacific/Guam,

Pacific/Honolulu,

Pacific/Majuro,

Pacific/Midway,

Pacific/Noumea,

Pacific/Pago_Pago,

Pacific/Port_Moresby,

Pacific/Tongatapu

Example:

"America/Los_Angeles"

city

string | null

required

The city of the customer's billing address

Example:

"Woodland Hills"

country

enum<string> | null

required

Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)

Available options:

null,

AD,

AE,

AF,

AG,

AI,

AL,

AM,

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,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

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,

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,

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,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW

Example:

"US"

currency

enum<string> | null

required

Currency of the customer. Format must be ISO 4217

Available options:

null,

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SYP,

SZL,

THB,

TJS,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

string<email> | null

required

The email of the customer

Example:

"dinesh@piedpiper.example"

legal_name

string | null

required

The legal company name of the customer

Example:

"Coleman-Blair"

legal_number

string | null

required

The legal company number of the customer

Example:

"49-008-2965"

logo_url

string | null

required

The logo URL of the customer

Example:

"http://hooli.com/logo.png"

name

string | null

required

The full name of the customer

Example:

"Gavin Belson"

firstname

string | null

required

First name of the customer

Example:

"Gavin"

lastname

string | null

required

Last name of the customer

Example:

"Belson"

account_type

enum<string>

required

The type of the account. It can have one of the following values:

customer: the account is a customer.
partner: the account is a partner.

Available options:

customer,

partner

Example:

"customer"

customer_type

enum<string> | null

required

The type of the customer. It can have one of the following values:

company: the customer is a company.
individual: the customer is an individual.

Available options:

company,

individual,

null

Example:

"company"

phone

string | null

required

The phone number of the customer

Example:

"1-171-883-3711 x245"

state

string | null

required

The state of the customer's billing address

Example:

"CA"

tax_identification_number

string | null

required

The tax identification number of the customer

Example:

"EU123456789"

timezone

enum<string> | null

required

The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone

Available options:

null,

UTC,

Africa/Algiers,

Africa/Cairo,

Africa/Casablanca,

Africa/Harare,

Africa/Johannesburg,

Africa/Monrovia,

Africa/Nairobi,

America/Argentina/Buenos_Aires,

America/Bogota,

America/Caracas,

America/Chicago,

America/Chihuahua,

America/Denver,

America/Godthab,

America/Guatemala,

America/Guyana,

America/Halifax,

America/Indiana/Indianapolis,

America/Juneau,

America/La_Paz,

America/Lima,

America/Los_Angeles,

America/Mazatlan,

America/Mexico_City,

America/Monterrey,

America/Montevideo,

America/New_York,

America/Phoenix,

America/Puerto_Rico,

America/Regina,

America/Santiago,

America/Sao_Paulo,

America/St_Johns,

America/Tijuana,

Asia/Almaty,

Asia/Baghdad,

Asia/Baku,

Asia/Bangkok,

Asia/Chongqing,

Asia/Colombo,

Asia/Dhaka,

Asia/Hong_Kong,

Asia/Irkutsk,

Asia/Jakarta,

Asia/Jerusalem,

Asia/Kabul,

Asia/Kamchatka,

Asia/Karachi,

Asia/Kathmandu,

Asia/Kolkata,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuwait,

Asia/Magadan,

Asia/Muscat,

Asia/Novosibirsk,

Asia/Rangoon,

Asia/Riyadh,

Asia/Seoul,

Asia/Shanghai,

Asia/Singapore,

Asia/Srednekolymsk,

Asia/Taipei,

Asia/Tashkent,

Asia/Tbilisi,

Asia/Tehran,

Asia/Tokyo,

Asia/Ulaanbaatar,

Asia/Urumqi,

Asia/Vladivostok,

Asia/Yakutsk,

Asia/Yekaterinburg,

Asia/Yerevan,

Atlantic/Azores,

Atlantic/Cape_Verde,

Atlantic/South_Georgia,

Australia/Adelaide,

Australia/Brisbane,

Australia/Darwin,

Australia/Hobart,

Australia/Melbourne,

Australia/Perth,

Australia/Sydney,

Europe/Amsterdam,

Europe/Athens,

Europe/Belgrade,

Europe/Berlin,

Europe/Bratislava,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

Europe/Copenhagen,

Europe/Dublin,

Europe/Helsinki,

Europe/Istanbul,

Europe/Kaliningrad,

Europe/Kiev,

Europe/Lisbon,

Europe/Ljubljana,

Europe/London,

Europe/Madrid,

Europe/Minsk,

Europe/Moscow,

Europe/Paris,

Europe/Prague,

Europe/Riga,

Europe/Rome,

Europe/Samara,

Europe/Sarajevo,

Europe/Skopje,

Europe/Sofia,

Europe/Stockholm,

Europe/Tallinn,

Europe/Vienna,

Europe/Vilnius,

Europe/Volgograd,

Europe/Warsaw,

Europe/Zagreb,

Europe/Zurich,

GMT+12,

Pacific/Apia,

Pacific/Auckland,

Pacific/Chatham,

Pacific/Fakaofo,

Pacific/Fiji,

Pacific/Guadalcanal,

Pacific/Guam,

Pacific/Honolulu,

Pacific/Majuro,

Pacific/Midway,

Pacific/Noumea,

Pacific/Pago_Pago,

Pacific/Port_Moresby,

Pacific/Tongatapu

Example:

"America/Los_Angeles"

url

string | null

required

The custom website URL of the customer

Example:

"http://hooli.com"

zipcode

string | null

required

The zipcode of the customer's billing address

Example:

"91364"

net_payment_term

integer | null

required

The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.

Example:

30

external_salesforce_id

string | null

required

The customer ID within the Salesforce system

Example:

"0015p00001JQx1QAAT"

created_at

string<date-time>

required

The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created

Example:

"2022-04-29T08:59:51Z"

updated_at

string<date-time>

required

The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated

Example:

"2022-04-29T08:59:51Z"

finalize_zero_amount_invoice

enum<string>

required

Specifies how invoices with a zero total amount should be handled:

inherit: (Default) Follows the organization-level configuration.
finalize: Invoices are issued and finalized even if the total amount is zero.
skip: Invoices with a total amount of zero are not finalized.

Available options:

inherit,

skip,

finalize

Example:

"inherit"

skip_invoice_custom_sections

boolean

required

Set to true to exclude all invoice custom sections from PDF generation for this customer only.

Example:

false

billing_configuration

object

required

Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer.

Show child attributes

shipping_address

object

required

The shipping address of the customer.

Show child attributes

metadata

object[]

required

Show child attributes

integration_customers

object[]

Show child attributes

taxes

object[]

List of customer taxes

Show child attributes

applicable_invoice_custom_sections

object[]

The customer's invoice custom sections used for generating invoices.

Show child attributes

error_details

object[]

List of errors with details that might have been raised while processing background actions for the customer

Show child attributes