{
  "organization": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Name1",
    "created_at": "2022-05-02T13:04:09Z",
    "webhook_url": "https://webhook.brex.com",
    "country": "US",
    "address_line1": "100 Brex Street",
    "address_line2": "string",
    "state": "NYC",
    "zipcode": "10000",
    "email": "brex@brex.com",
    "city": "New York",
    "legal_name": "string",
    "legal_number": "string",
    "net_payment_term": 30,
    "default_currency": "USD",
    "tax_identification_number": "US123456789",
    "timezone": "America/New_York",
    "document_numbering": "per_customer",
    "document_number_prefix": "LAGO-INV",
    "billing_configuration": {
      "invoice_footer": "This is my customer footer",
      "invoice_grace_period": 3,
      "document_locale": "en",
      "vat_rate": "15.0"
    }
  }
}

​
Attributes

organization
object
lago_id
string
required

Unique identifier assigned to your 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.

name
string
required

The name of your organization.

created_at
string
required

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

webhook_url
string

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.

webhook_urls
array

The URLs of all your webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. The number of endpoints created is currently limited to 5.

country
string

The country of your organization.

address_line1
string

The first line of your organization’s billing address.

address_line2
string

The second line of your organization’s billing address.

state
string

The state of your organization’s billing address.

zipcode
string

The zipcode of your organization’s billing address.

email
string

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

city
string

The city of your organization’s billing address.

legal_name
string

The legal name of your organization.

legal_number
string

The legal number of your organization.

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.

default_currency
string

Currency of the organization. Format must be ISO 4217.

tax_identification_number
string

The tax identification number of your organization.

timezone
string

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

email_settings
array

Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are invoice.finalized and credit_note.created. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email.

email_settings
array

Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are invoice.finalized and credit_note.created. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email.

document_numbering
string

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.

document_number_prefix
string

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.

billing_configuration
object

Was this page helpful?

List all invoicesUpdate your organization