GEgetlago
billing_entities

Retrieve a billing entity

Changed on

This endpoint returns a specific billing entity by its code

get/billing_entities/{code}

Request

Response

Billing entity details

Example response

{
  "billing_entity": {
    "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",
    "phone": "1-171-883-3711 x245",
    "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,
        "applied_to_billing_entities_codes": [
          "acme_corp",
          "foo_bar"
        ],
        "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"
      }
    ]
  }
}

Changes

  • 5d26657495a3Revision changes
    • breaking

      the response property ///// became nullable for the status

    • warning

      added the new SYP enum value to the ///// response property for the response status

    • warning

      added the new TND enum value to the ///// response property for the response status

    • warning

      added the new undefined enum value to the ///// response property for the response status

    • info

      removed the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property //// became required for the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status