Update a billing entity
This endpoint is used to update an existing billing entity
Request body
The name of the billing entity
The type of document numbering for this billing entity:
- per_customer: document numbers are unique per customer
- per_billing_entity: document numbers are unique per billing entity
The prefix used in document numbers for this billing entity
Whether to finalize invoices with zero amount for this billing entity
The net payment term (in days) for this billing entity
The first line of the billing address
The second line of the billing address
The city of the billing address
The state of the billing address
The zipcode of the billing address
The email address of the billing entity
The legal name of the billing entity
The legal registration number of the billing entity
The tax identification number of the billing entity
List of unique code used to identify the taxes.
The email notification settings for this billing entity
Whether EU tax management is enabled for this billing entity
The base64 encoded logo image for the billing entity. Sending "null" will remove the logo, if any exist.
The codes of the invoice custom section that should be associated with this billing entity
Example request
{
"name": "Acme Corp",
"default_currency": "USD",
"document_number_prefix": "ABC-123",
"finalize_zero_amount_invoice": true,
"billing_configuration": {
"invoice_footer": "Thank you for your business",
"document_locale": "en"
},
"address_line1": "5230 Penfield Ave",
"address_line2": "Suite 100",
"city": "Woodland Hills",
"state": "CA",
"country": "US",
"zipcode": "91364",
"email": "billing@acme.com",
"legal_name": "Acme Corporation",
"legal_number": "US123456789",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"tax_codes": [
"french_standard_vat"
],
"logo": "data:image/png;base64,...",
"invoice_custom_section_codes": [
"custom_section_1",
"custom_section_2"
]
}Response
Billing entity updated
A unique identifier for the billing entity in the Lago application
The unique code of the billing entity
The name of the billing entity
The language of the documents generated for this billing entity
The type of document numbering for this billing entity:
- per_customer: document numbers are unique per customer
- per_billing_entity: document numbers are unique per billing entity
The prefix used in document numbers for this billing entity
Whether to finalize invoices with zero amount for this billing entity
The footer text to be displayed on invoices for this billing entity
The grace period (in days) for invoice finalization
Defines whether the issuing date follows the current billing period's end date or the next period starting date.
The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.
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
The net payment term (in days) for this billing entity
The first line of the billing address
The second line of the billing address
The city of the billing address
The state of the billing address
The zipcode of the billing address
The email address of the billing entity
The legal name of the billing entity
The legal registration number of the billing entity
The tax identification number of the billing entity
The email notification settings for this billing entity
Whether EU tax management is enabled for this billing entity
The URL of the billing entity's logo
The date and time when the billing entity was created
The date and time when the billing entity was last updated
Example response
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"code": "acme_corp",
"name": "Acme Corp",
"default_currency": "USD",
"document_locale": "en",
"document_numbering": "per_customer",
"document_number_prefix": "ABC-123",
"finalize_zero_amount_invoice": true,
"invoice_footer": "Thank you for your business",
"address_line1": "5230 Penfield Ave",
"address_line2": "Suite 100",
"city": "Woodland Hills",
"state": "CA",
"country": "US",
"zipcode": "91364",
"email": "billing@acme.com",
"legal_name": "Acme Corporation",
"legal_number": "US123456789",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"logo_url": "https://getlago.com/logo.png",
"created_at": "2022-04-29T08:59:51Z",
"updated_at": "2022-04-29T08:59:51Z",
"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"
}
],
"selected_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"
}
]
}