The organization object

lago_id

string

required

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

Example:

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

name

string

required

The name of your organization.

Example:

"Name1"

created_at

string | null

required

The date of creation of your organization, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-05-02T13:04:09Z"

document_numbering

enum<string>

required

This parameter configures the method of incrementing invoice numbers for your customers.

per_customer: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.
per_organization: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.

The default value for document_numbering is set to per_customer, meaning that, unless changed, invoice numbers will increment uniquely for each customer.

Available options:

per_customer,

per_organization

Example:

"per_customer"

document_number_prefix

string

required

Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.

Example:

"ORG-1234"

billing_configuration

object

required

The custom billing settings for your organization.

webhook_url

string | null

The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner.

Example:

"https://webhook.brex.com"

webhook_urls

string[] | null

The array containing your webhooks URLs.

Example:

[
  "https://webhook.brex.com",
  "https://webhook2.brex.com"
]

country

enum<string> | null

The country of your organization.

Available options:

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"

default_currency

enum<string>

The default currency of an organization.

Available options:

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

address_line1

string | null

The first line of your organization's billing address.

Example:

"100 Brex Street"

address_line2

string | null

The second line of your organization's billing address.

Example:

null

state

string | null

The state of your organization's billing address.

Example:

"NYC"

zipcode

string | null

The zipcode of your organization's billing address.

Example:

"10000"

string | null

The email address of your organization used to bill your customers.

Example:

"brex@brex.com"

city

string | null

The city of your organization's billing address.

Example:

"New York"

legal_name

string | null

The legal name of your organization.

Example:

null

legal_number

string | null

The legal number of your organization.

Example:

null

net_payment_term

integer

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

tax_identification_number

string | null

The tax identification number of your organization.

Example:

"US123456789"

timezone

enum<string>

Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.

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/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/New_York"

taxes

object[]

List of default organization taxes

finalize_zero_amount_invoice

boolean

Indicates whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.

Example:

false

Was this page helpful?

Suggest edits Raise issue

List all invoices Update your organization

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "name": "Name1",
  "created_at": "2022-05-02T13:04:09Z",
  "webhook_url": "https://webhook.brex.com",
  "webhook_urls": [
    "https://webhook.brex.com",
    "https://webhook2.brex.com"
  ],
  "country": "US",
  "default_currency": "USD",
  "address_line1": "100 Brex Street",
  "address_line2": null,
  "state": "NYC",
  "zipcode": "10000",
  "email": "brex@brex.com",
  "city": "New York",
  "legal_name": null,
  "legal_number": null,
  "document_numbering": "per_customer",
  "document_number_prefix": "ORG-1234",
  "net_payment_term": 30,
  "tax_identification_number": "US123456789",
  "timezone": "America/New_York",
  "billing_configuration": {
    "invoice_footer": "This is my customer footer",
    "invoice_grace_period": 3,
    "document_locale": "en"
  },
  "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"
    }
  ],
  "finalize_zero_amount_invoice": false
}

API Reference