Create a billing entity
This endpoint is used to create a new billing entity
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The billing entity payload
Billing entity create input
Response
Billing entity created
Billing entity object
A unique identifier for the billing entity in the Lago application
"1a901a90-1a90-1a90-1a90-1a901a901a90"
The unique code of the billing entity
"acme_corp"
The name of the billing entity
"Acme Corp"
The default currency of the billing entity
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
, GHS
, 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
, SZL
, THB
, TJS
, TOP
, TRY
, TTD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VND
, VUV
, WST
, XAF
, XCD
, XOF
, XPF
, YER
, ZAR
, ZMW
"USD"
The language of the documents generated for this billing entity
"en"
The type of document numbering for this billing entity:
per_customer
: document numbers are unique per customerper_billing_entity
: document numbers are unique per billing entity
per_customer
, per_billing_entity
"per_customer"
Whether to finalize invoices with zero amount for this billing entity
true
The grace period (in days) for invoice finalization
0
The net payment term (in days) for this billing entity
0
The timezone of the billing entity
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
"America/Los_Angeles"
The date and time when the billing entity was created
"2022-04-29T08:59:51Z"
The date and time when the billing entity was last updated
"2022-04-29T08:59:51Z"
The prefix used in document numbers for this billing entity
"ABC-123"
The footer text to be displayed on invoices for this billing entity
"Thank you for your business"
Whether this billing entity is the default billing entity for the organization. Default billing entity will be used as fallback in services if no billing entity is specified when billing_entity is not provided. Default billing entity is the billing entity that will be used to generate invoices if no billing entity is specified when invoice is created. is the oldest active billing entity and this flag cannot be changed
false
The first line of the billing address
"5230 Penfield Ave"
The second line of the billing address
"Suite 100"
The city of the billing address
"Woodland Hills"
The state of the billing address
"CA"
The country code of the billing address
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
"US"
The zipcode of the billing address
"91364"
The email address of the billing entity
"billing@acme.com"
The legal name of the billing entity
"Acme Corporation"
The legal registration number of the billing entity
"US123456789"
The tax identification number of the billing entity
"EU123456789"
The email notification settings for this billing entity
Whether EU tax management is enabled for this billing entity
false
The URL of the billing entity's logo
"https://getlago.com/logo.png"