--- title: "Returns the current comapny" method: POST path: "/api/v1/companies/current" tags: ["companies"] --- # Returns the current comapny `POST /api/v1/companies/current` ## Request - Base URL: `https://demo.invoiceninja.com` - URL: `https://demo.invoiceninja.com/api/v1/companies/current` - Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the current company based on the API token passed in ## Query parameters - `include` string ## Headers - `X-API-TOKEN` string, required - `X-Requested-With` string, required ## Response `200` Returns the company object - Company - `id` string: The unique hashed identifier for the company - `size_id` string: The unique identifier representing the company's size category - `industry_id` string: The unique identifier representing the company's industry category - `slack_webhook_url` string: The URL for the company's Slack webhook notifications - `google_analytics_key` string: The company's Google Analytics tracking ID - `portal_mode` string: The mode determining how client-facing URLs are structured (e.g., subdomain, domain, or iframe) - `subdomain` string: The subdomain prefix for the company's domain (e.g., 'acme' in acme.domain.com) - `portal_domain` string: The fully qualified domain used for client-facing URLs - `enabled_tax_rates` integer: The number of tax rates used per entity - `fill_products` boolean: A flag determining whether to auto-fill product descriptions based on the product key - `convert_products` boolean: A flag determining whether to convert products between different types or units - `update_products` boolean: A flag determining whether to update product descriptions when the description changes - `show_product_details` boolean: A flag determining whether to display product details in the user interface - `show_product_cost` boolean: A flag determining whether to display product cost is shown in the user interface - `custom_fields` object: A mapping of custom fields for various objects within the company **note** The custom fields object is formatted as follows key : value entity(integer) : label|type for example: "company1": "Number|single_line_text", This defines the first company custom field, with label Number which has a custom field type of a single text line Supported entity types invoice product client contact task user project vendor expense payment Supported input types values single_line_text date switch For text areas, you only need to supply the label ie "TextArea", the | and type values are not required. For the dropdown the data format is as follows: label|your,drop,down,values,in,comma,separated,format - `enable_product_cost` boolean: A flag determining whether to show or hide the product cost field in the user interface - `enable_product_quantity` boolean: A flag determining whether to show or hide the product quantity field in the user interface - `default_quantity` boolean: A flag determining whether to use a default quantity for products - `custom_surcharge_taxes1` boolean: A flag determining whether to apply taxes on custom surcharge amounts for the first custom surcharge field - `custom_surcharge_taxes2` boolean: A flag determining whether to apply taxes on custom surcharge amounts for the second custom surcharge field - `custom_surcharge_taxes3` boolean: A flag determining whether to apply taxes on custom surcharge amounts for the third custom surcharge field - `custom_surcharge_taxes4` unknown - `logo` string, binary: The company logo file in binary format - `company_key` string: The static company key hash used to identify the Company - `client_can_register` boolean: A flag determining whether clients can register for the client portal - `enabled_modules` integer: Bitmask representation of the modules that are enabled in the application ``` self::ENTITY_RECURRING_INVOICE => 1, self::ENTITY_CREDIT => 2, self::ENTITY_QUOTE => 4, self::ENTITY_TASK => 8, self::ENTITY_EXPENSE => 16, self::ENTITY_PROJECT => 32, self::ENTITY_VENDOR => 64, self::ENTITY_TICKET => 128, self::ENTITY_PROPOSAL => 256, self::ENTITY_RECURRING_EXPENSE => 512, self::ENTITY_RECURRING_TASK => 1024, self::ENTITY_RECURRING_QUOTE => 2048, ``` The default per_page value is 20. - `db` string - `first_day_of_week` string: The first day of the week for the company - `first_month_of_year` string: The first month for the company financial year - `enabled_item_tax_rates` integer: The number of tax rates used per item - `is_large` boolean: A flag determining whether the company is considered large - `default_auto_bill` string: A flag determining whether to auto-bill clients by default values: - always - Always auto bill - disabled - Never auto bill - optin - Allow the client to select their auto bill status with the default being disabled - optout -Allow the client to select their auto bill status with the default being enabled - `mark_expenses_invoiceable` boolean: A flag determining whether to mark expenses as invoiceable by default - `mark_expenses_paid` boolean: A flag determining whether to mark expenses as paid by default - `invoice_expense_documents` boolean: A flag determining whether to include expense documents on invoices by default - `auto_start_tasks` boolean: A flag determining whether to auto-start tasks by default - `invoice_task_timelog` boolean: A flag determining whether to include task time logs on invoices by default - `invoice_task_documents` boolean: A flag determining whether to include task documents on invoices by default - `show_tasks_table` boolean: A flag determining whether to show the tasks table on invoices by default - `is_disabled` boolean: A flag determining whether the company is disabled - `default_task_is_date_based` boolean: A flag determining whether to default tasks to be date-based - `enable_product_discount` boolean: A flag determining whether to show or hide the product discount field in the user interface - `calculate_expense_tax_by_amount` boolean: A flag determining whether to calculate expense taxes by amount - `expense_inclusive_taxes` boolean: A flag determining whether to include taxes in the expense amount - `session_timeout` integer: The session timeout for the company - `oauth_password_required` boolean: A flag determining whether to require a password for `dangerous` actions when using OAuth - `invoice_task_datelog` boolean: A flag determining whether to include task date logs on invoices by default - `default_password_timeout` integer: The default password timeout for the company - `show_task_end_date` boolean: A flag determining whether to show the task end date on invoices by default - `markdown_enabled` boolean: A flag determining whether markdown is enabled for the company - `report_include_drafts` boolean: A flag determining whether to include draft invoices in reports - `client_registration_fields` object: The client registration fields for the company - `stop_on_unpaid_recurring` boolean: A flag determining whether to stop recurring invoices when they are unpaid - `use_quote_terms_on_conversion` boolean: A flag determining whether to use quote terms on conversion to an invoice - `enable_applying_payments` boolean: A flag determining whether to enable applying payments to invoices - `track_inventory` boolean: A flag determining whether to track inventory for the company - `inventory_notification_threshold` integer: The inventory notification threshold for the company - `stock_notification` boolean: A flag determining whether to send stock notifications for the company - `matomo_url` string: The Matomo URL for the company - `matomo_id` string: The Matomo ID for the company - `enabled_expense_tax_rates` integer: The number of tax rates used per expense - `invoice_task_project` boolean: A flag determining whether to include the project on invoices by default - `report_include_deleted` boolean: A flag determining whether to include deleted invoices in reports - `invoice_task_lock` boolean: A flag determining whether to lock tasks when invoiced - `convert_payment_currency` boolean: A flag determining whether to convert the payment currency - `convert_expense_currency` boolean: A flag determining whether to convert the expense currency - `notify_vendor_when_paid` boolean: A flag determining whether to notify the vendor when an expense is paid - `invoice_task_hours` boolean: A flag determining whether to include the task hours on invoices by default - `calculate_taxes` boolean: A flag determining whether to calculate taxes for the company - `tax_data` object: The tax data for the company - `e_invoice_certificate` string: The e-invoice certificate for the company - `e_invoice_certificate_passphrase` string: The e-invoice certificate passphrase for the company - `origin_tax_data` object: The origin tax data for the company - `invoice_task_project_header` boolean: A flag determining whether to include the project header on invoices by default - `invoice_task_item_description` boolean: A flag determining whether to include the item description on invoices by default - `expense_mailbox` string: The email address for the expense mailbox - `expense_mailbox_active` boolean: Whether the expense mailbox is active - `inbound_mailbox_allow_company_users` boolean: Whether company users are allowed to use the inbound mailbox - `inbound_mailbox_allow_vendors` boolean: Whether vendors are allowed to use the inbound mailbox - `inbound_mailbox_allow_clients` boolean: Whether clients are allowed to use the inbound mailbox - `inbound_mailbox_allow_unknown` boolean: Whether unknown senders are allowed to use the inbound mailbox - `inbound_mailbox_whitelist` string: Comma-separated list of whitelisted email addresses for the inbound mailbox - `inbound_mailbox_blacklist` string: Comma-separated list of blacklisted email addresses for the inbound mailbox - `smtp_host` string: The SMTP host for sending emails - `smtp_port` integer: The SMTP port for sending emails - `smtp_encryption` 'tls' | 'ssl', nullable: The encryption method for SMTP - `smtp_local_domain` string: The local domain for SMTP - `smtp_verify_peer` boolean: Whether to verify the SMTP peer - `e_invoice` object: E-invoice settings for the company - `legal_entity_id` integer: The ID of the legal entity associated with the company - `convert_rate_to_client` boolean: Flag indicating whether to convert rates to the client currency - `e_invoicing_token` string: Authentication token for e-invoicing services - `enable_shop_api` boolean: Flag indicating whether the shop API is enabled - `markdown_email_enabled` boolean: Flag indicating whether markdown formatting is enabled in emails - `use_comma_as_decimal_place` boolean: Flag indicating whether to use comma as decimal separator instead of period - `settings` CompanySettings - `currency_id` string, required: The default currency id - `timezone_id` string: The timezone id - `date_format_id` string: The date format id - `military_time` boolean: Toggles 12/24 hour time - `language_id` string: The language id - `show_currency_code` boolean: Toggles whether the currency symbol or code is shown - `payment_terms` integer: -1 sets no payment term, 0 sets payment due immediately, positive integers indicates payment terms in days - `company_gateway_ids` string: A commad separate list of available gateways - `custom_value1` string: A Custom Label - `custom_value2` string: A Custom Label - `custom_value3` string: A Custom Label - `custom_value4` string: A Custom Label - `default_task_rate` number, float: The default task rate - `send_reminders` boolean: Toggles whether reminders are sent - `enable_client_portal_tasks` boolean: Show/hide the tasks panel in the client portal - `email_style` 'plain' | 'light' | 'dark' | 'custom': options include plain,light,dark,custom - `reply_to_email` string, email: The reply to email address - `bcc_email` string: A comma separate list of BCC emails - `pdf_email_attachment` boolean: Toggles whether to attach PDF as attachment - `ubl_email_attachment` boolean: Toggles whether to attach UBL as attachment - `email_style_custom` string: The custom template - `counter_number_applied` 'when_saved' | 'when_sent' | 'when_paid': enum when the invoice number counter is set - `quote_number_applied` 'when_saved' | 'when_sent': enum when the quote number counter is set - `custom_message_dashboard` string: A custom message which is displayed on the dashboard - `custom_message_unpaid_invoice` string: A custom message which is displayed in the client portal when a client is viewing a unpaid invoice. - `custom_message_paid_invoice` string: A custom message which is displayed in the client portal when a client is viewing a paid invoice. - `custom_message_unapproved_quote` string: A custom message which is displayed in the client portal when a client is viewing a unapproved quote. - `lock_invoices` 'off' | 'when_sent' | 'when_paid' | 'end_of_month': Toggles whether invoices are locked once sent and cannot be modified further - `auto_archive_invoice` boolean: Toggles whether a invoice is archived immediately following payment - `auto_archive_quote` boolean: Toggles whether a quote is archived after being converted to a invoice - `auto_convert_quote` boolean: Toggles whether a quote is converted to a invoice when approved - `inclusive_taxes` boolean: Boolean flag determining whether inclusive or exclusive taxes are used - `translations` object: JSON payload of customized translations - `task_number_pattern` string: Allows customisation of the task number pattern - `task_number_counter` integer: The incrementing counter for tasks - `reminder_send_time` integer: Time from UTC +0 when the email will be sent to the client - `expense_number_pattern` string: Allows customisation of the expense number pattern - `expense_number_counter` integer: The incrementing counter for expenses - `vendor_number_pattern` string: Allows customisation of the vendor number pattern - `vendor_number_counter` integer: The incrementing counter for vendors - `ticket_number_pattern` string: Allows customisation of the ticket number pattern - `ticket_number_counter` integer: The incrementing counter for tickets - `payment_number_pattern` string: Allows customisation of the payment number pattern - `payment_number_counter` integer: The incrementing counter for payments - `invoice_number_pattern` string: Allows customisation of the invoice number pattern - `invoice_number_counter` integer: The incrementing counter for invoices - `quote_number_pattern` string: Allows customisation of the quote number pattern - `quote_number_counter` integer: The incrementing counter for quotes - `client_number_pattern` string: Allows customisation of the client number pattern - `client_number_counter` integer: The incrementing counter for clients - `credit_number_pattern` string: Allows customisation of the credit number pattern - `credit_number_counter` integer: The incrementing counter for credits - `recurring_invoice_number_prefix` string: This string is prepended to the recurring invoice number - `reset_counter_frequency_id` integer: CONSTANT which is used to apply the frequency which the counters are reset - `reset_counter_date` string, date: The explicit date which is used to reset counters - `counter_padding` integer: Pads the counter with leading zeros - `shared_invoice_quote_counter` boolean: Flags whether to share the counter for invoices and quotes - `update_products` boolean: Determines if client fields are updated from third party APIs - `convert_products` boolean - `fill_products` boolean: Automatically fill products based on product_key - `invoice_terms` string: The default invoice terms - `quote_terms` string: The default quote terms - `invoice_taxes` integer: The number of Taxes that can be applied to the invoice - `invoice_design_id` string: The default design id (invoice, quote etc) - `quote_design_id` string: The default design id (invoice, quote etc) - `invoice_footer` string: The default invoice footer - `invoice_labels` string: JSON string of invoice labels - `tax_rate1` number, float: The tax rate (float) - `tax_name1` string: The tax name - `tax_rate2` number, float: The tax rate (float) - `tax_name2` string: The tax name - `tax_rate3` number, float: The tax rate (float) - `tax_name3` string: The tax name - `payment_type_id` string: The default payment type id - `custom_fields` string: JSON string of custom fields - `email_footer` string: The default email footer - `email_sending_method` 'default' | 'gmail' | 'office365' | 'client_postmark' | 'client_mailgun' | 'mailgun' | 'client_brevo': The email driver to use to send email - `gmail_sending_user_id` string: The hashed_id of the user account to send email from - `email_subject_invoice` string - `email_subject_quote` string - `email_subject_payment` string - `email_template_invoice` string: The full template for invoice emails - `email_template_quote` string: The full template for quote emails - `email_template_payment` string: The full template for payment emails - `email_subject_reminder1` string: Email subject for Reminder - `email_subject_reminder2` string: Email subject for Reminder - `email_subject_reminder3` string: Email subject for Reminder - `email_subject_reminder_endless` string: Email subject for endless reminders - `email_template_reminder1` string: The full template for Reminder 1 - `email_template_reminder2` string: The full template for Reminder 2 - `email_template_reminder3` string: The full template for Reminder 3 - `email_template_reminder_endless` string: The full template for enless reminders - `enable_portal_password` boolean: Toggles whether a password is required to log into the client portal - `show_accept_invoice_terms` boolean: Toggles whether the terms dialogue is shown to the client - `show_accept_quote_terms` boolean: Toggles whether the terms dialogue is shown to the client - `require_invoice_signature` boolean: Toggles whether a invoice signature is required - `require_quote_signature` boolean: Toggles whether a quote signature is required - `name` string: The company name - `company_logo` string: The company logo file - `website` string, uri: The company website URL - `address1` string: The company address line 1 - `address2` string: The company address line 2 - `city` string: The company city - `state` string: The company state - `postal_code` string: The company zip/postal code - `phone` string: The company phone - `email` string, email: The company email - `country_id` string: The country ID - `vat_number` string: The company VAT/TAX ID number - `page_size` string: The default page size - `font_size` number: The font size - `primary_font` string: The primary font - `secondary_font` string: The secondary font - `hide_paid_to_date` boolean: Flags whether to hide the paid to date field - `embed_documents` boolean: Toggled whether to embed documents in the PDF - `all_pages_header` boolean: The header for the PDF - `all_pages_footer` boolean: The footer for the PDF - `document_email_attachment` boolean: Toggles whether to attach documents in the email - `enable_client_portal_password` boolean: Toggles password protection of the client portal - `enable_email_markup` boolean: Toggles the use of markdown in emails - `enable_client_portal_dashboard` boolean: Toggles whether the client dashboard is shown in the client portal - `enable_client_portal` boolean: Toggles whether the entire client portal is displayed to the client, or only the context - `email_template_statement` string: The body of the email for statements - `email_subject_statement` string: The subject of the email for statements - `signature_on_pdf` boolean: Toggles whether the signature (if available) is displayed on the PDF - `quote_footer` string: The default quote footer - `email_subject_custom1` string: Custom reminder template subject - `email_subject_custom2` string: Custom reminder template subject - `email_subject_custom3` string: Custom reminder template subject - `email_template_custom1` string: Custom reminder template body - `email_template_custom2` string: Custom reminder template body - `email_template_custom3` string: Custom reminder template body - `enable_reminder1` boolean: Toggles whether this reminder is enabled - `enable_reminder2` boolean: Toggles whether this reminder is enabled - `enable_reminder3` boolean: Toggles whether this reminder is enabled - `num_days_reminder1` integer: The Reminder interval - `num_days_reminder2` integer: The Reminder interval - `num_days_reminder3` integer: The Reminder interval - `schedule_reminder1` 'after_invoice_date' | 'before_due_date' | 'after_due_date': (enum: after_invoice_date, before_due_date, after_due_date) - `schedule_reminder2` 'after_invoice_date' | 'before_due_date' | 'after_due_date': (enum: after_invoice_date, before_due_date, after_due_date) - `schedule_reminder3` 'after_invoice_date' | 'before_due_date' | 'after_due_date': (enum: after_invoice_date, before_due_date, after_due_date) - `late_fee_amount1` number, float: The late fee amount for reminder 1 - `late_fee_amount2` number, float: The late fee amount for reminder 2 - `late_fee_amount3` number, float: The late fee amount for reminder 2 - `endless_reminder_frequency_id` string: The frequency id of the endless reminder - `client_online_payment_notification` boolean: Determines if a client should receive the notification for a online payment - `client_manual_payment_notification` boolean: Determines if a client should receive the notification for a manually entered payment - `enable_e_invoice` boolean: Determines if e-invoicing is enabled - `default_expense_payment_type_id` string: The default payment type for expenses - `e_invoice_type` string: The e-invoice type - `mailgun_endpoint` 'api.mailgun.net' | 'api.eu.mailgun.net': The mailgun endpoint - used to determine whether US or EU endpoints are used - `client_initiated_payments` boolean: Determines if clients can initiate payments directly from the client portal - `client_initiated_payments_minimum` number, float: The minimum amount a client can pay - `sync_invoice_quote_columns` boolean: Determines if invoice and quote columns are synced for the PDF rendering, or if they use their own columns - `show_task_item_description` boolean: Determines if the task item description is shown on the invoice - `allow_billable_task_items` boolean: Determines if task items can be marked as billable - `accept_client_input_quote_approval` boolean: Determines if clients can approve quotes and also pass through a PO Number reference - `custom_sending_email` string, email: When using Mailgun or Postmark, the FROM email address can be customized using this setting. - `show_paid_stamp` boolean: Determines if the PAID stamp is shown on the invoice - `show_shipping_address` boolean: Determines if the shipping address is shown on the invoice - `company_logo_size` integer: The size of the company logo on the PDF - percentage value between 0 and 100 - `show_email_footer` boolean: Determines if the email footer is shown on emails - `email_alignment` 'left' | 'center' | 'right': The alignment of the email body text, options include left / center / right - `auto_bill_standard_invoices` boolean: Determines if standard invoices are automatically billed when they are created or due - `postmark_secret` string: The Postmark secret API key - `mailgun_secret` string: The Mailgun secret API key - `mailgun_domain` string: The Mailgun domain - `send_email_on_mark_paid` boolean: Determines if an email is sent when an invoice is marked as paid - `vendor_portal_enable_uploads` boolean: Determines if vendors can upload files to the portal - `besr_id` string: The BESR ID - `qr_iban` string: The IBAN for the QR code - `email_subject_purchase_order` string: The email subject for purchase orders - `email_template_purchase_order` string: The email template for purchase orders - `require_purchase_order_signature` boolean: Determines if a signature is required on purchase orders - `purchase_order_public_notes` string: The public notes for purchase orders - `purchase_order_terms` string: The terms for purchase orders - `purchase_order_footer` string: The footer for purchase orders - `purchase_order_design_id` string: The design id for purchase orders - `purchase_order_number_pattern` string: The pattern for purchase order numbers - `purchase_order_number_counter` integer: The counter for purchase order numbers - `page_numbering_alignment` 'left' | 'center' | 'right': The alignment for page numbering: options include left / center / right - `page_numbering` boolean: Determines if page numbering is enabled on Document PDFs - `auto_archive_invoice_cancelled` boolean: Determines if invoices are automatically archived when they are cancelled - `email_from_name` string: The FROM name for emails when using Custom emailers - `show_all_tasks_client_portal` 'all' | 'uninvoiced' | 'invoiced': Determines if all tasks are shown on the client portal - `entity_send_time` integer: The time that emails are sent. The time is localized to the clients locale, integer values from 1 - 24 - `shared_invoice_credit_counter` boolean: Determines if the invoice and credit counter are shared - `reply_to_name` string: The reply to name for emails - `hide_empty_columns_on_pdf` boolean: Determines if empty columns are hidden on PDFs - `enable_reminder_endless` boolean: Determines if endless reminders are enabled - `use_credits_payment` boolean: Determines if credits can be used as a payment method - `recurring_invoice_number_pattern` string: The pattern for recurring invoice numbers - `recurring_invoice_number_counter` integer: The counter for recurring invoice numbers - `client_portal_under_payment_minimum` number, float: The minimum payment payment - `auto_bill_date` 'on_send_date' | 'on_due_date': Determines when the invoices are auto billed - `primary_color` string: The primary color for the client portal / document highlights - `secondary_color` string: The secondary color for the client portal / document highlights - `client_portal_allow_under_payment` boolean: Determines if clients can pay invoices under the invoice amount due - `client_portal_allow_over_payment` boolean: Determines if clients can pay invoices over the invoice amount - `auto_bill` 'off' | 'always' | 'optin' | 'optout': Determines how autobilling is applied for recurring invoices - `client_portal_terms` string: The terms which are displayed on the client portal - `client_portal_privacy_policy` string: The privacy policy which is displayed on the client portal - `client_can_register` boolean: Determines if clients can register on the client portal - `portal_design_id` string: The design id for the client portal - `late_fee_endless_percent` number, float: The late fee percentage for endless late fees - `late_fee_endless_amount` number, float: The late fee amount for endless late fees - `auto_email_invoice` boolean: Determines if invoices are automatically emailed when they are created - `email_signature` string: The email signature for emails - `classification` string: The classification for the company - `valid_until` string: Default validity period for quotes - `credit_terms` string: Default terms for credit notes - `credit_footer` string: Default footer for credit notes ## Other responses - `401`: Authentication error - `403`: Authorization error - `422`: Validation error - `429`: Rate Limit Exceeded - `5XX`: Server error - `default`: Unexpected Error ## Changes - **2026-04-20** `69a36036d334`: 1 info - the response optional property `id` became read-only for the status `200` - **2026-02-09** `c85938f55efd`: 1 breaking, 1 info - the response property `smtp_encryption` became nullable for the status `200` - removed the `undefined` enum value from the `smtp_encryption` response property for the response status `200` - **2025-11-22** `00ad5cc89fad`: 5 info - added the optional property `convert_rate_to_client` to the response with the `200` status - added the optional property `e_invoicing_token` to the response with the `200` status - added the optional property `enable_shop_api` to the response with the `200` status - added the optional property `markdown_email_enabled` to the response with the `200` status - …1 more - **2025-09-26** `536b69720520`: 1 breaking, 3 warning - the `settings/show_all_tasks_client_portal` response's property type changed from `boolean` to `string` for status `200` - added the new `all` enum value to the `settings/show_all_tasks_client_portal` response property for the response status `200` - added the new `invoiced` enum value to the `settings/show_all_tasks_client_portal` response property for the response status `200` - added the new `uninvoiced` enum value to the `settings/show_all_tasks_client_portal` response property for the response status `200` - …earlier changes not shown [Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/companies/current/post.md) --- [API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)