--- title: "Returns a list of activities" method: GET path: "/api/v1/activities" tags: ["activities"] --- # Returns a list of activities `GET /api/v1/activities` ## Request - Base URL: `https://demo.invoiceninja.com` - URL: `https://demo.invoiceninja.com/api/v1/activities` - Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With` - TypeScript: (a function with typed inputs; its response is checked against the schema) Lists all activities related to this company ## Query parameters - `include` string - `index` string - `per_page` integer - `page` integer ## Headers - `X-API-TOKEN` string, required - `X-Requested-With` string, required ## Response `200` Returns the list of activities - object - `data` Activity[] - `id` string: The id field of the activity - `activity_type_id` string: The activity type id - `client_id` string: The client hashed id - `company_id` string: The company hashed id - `user_id` string: The user hashed id - `invoice_id` string: The invoice hashed id - `payment_id` string: The payment hashed id - `credit_id` string: The credit hashed id - `updated_at` integer: Unixtimestamp the last time the record was updated - `expense_id` string: The expense hashed id - `is_system` boolean: Defines is the activity was performed by the system - `contact_id` string: The contact hashed id - `task_id` string: The task hashed id - `notes` string: Activity Notes - `token_id` string: The hashed ID of the token who performed the action - `ip` string: The IP Address of the user who performed the action - `user` User - `id` string: The hashed id of the user - `first_name` string: The first name of the user - `last_name` string: The last name of the user - `email` string: The users email address - `phone` string: The users phone number - `signature` string: The users sign off signature - `avatar` string: The users avatar - `accepted_terms_version` string: The version of the invoice ninja terms that has been accepted by the user - `oauth_user_id` string: The provider id of the oauth entity - `oauth_provider_id` string: The oauth entity id - `language_id` string: The language id of the user - `verified_phone_number` boolean: Boolean flag if the user has their phone verified. Required to settings up 2FA - `sms_verification_code` string: The sms verification code for the user. Required to settings up 2FA - `oauth_user_token_expiry` string: The expiry date of the oauth token - `has_password` boolean: Boolean flag determining if the user has a password - `last_confirmed_email_address` string: The last confirmed email address of the user - `custom_value1` string: A custom value - `custom_value2` string: A custom value - `custom_value3` string: A custom value - `custom_value4` string: A custom value - `is_deleted` boolean: Boolean flag determining if the user has been deleted - `google_2fa_secret` string: The google 2fa secret for the user - `passkey_enabled` boolean: Boolean flag if passkey auth is enabled for this user - `passkey_count` integer: The number of registered passkeys for this user - `company_user` CompanyUserRef - `permissions` string: The user permissions for this company in a comma separated list - `settings` object: Settings that are used for the flutter applications to store user preferences / metadata - `react_settings` object: Dedicated settings object for the react web application - `is_owner` boolean: Determines whether the user owns this company - `is_admin` boolean: Determines whether the user is the admin of this company - `is_locked` boolean: Determines whether the users access to this company has been locked - `updated_at` integer: The last time the record was modified, format Unix Timestamp - `deleted_at` integer: Timestamp when the user was archived, format Unix Timestamp - `account` Account - `id` string: The account hashed id - `account_sms_verified` string: Boolean flag if the account has been verified by sms - `company` 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 - `user` UserRef - `id` string: The hashed id of the user - `first_name` string: The first name of the user - `last_name` string: The last name of the user - `email` string: The users email address - `phone` string: The users phone number - `signature` string: The users sign off signature - `avatar` string: The users avatar - `accepted_terms_version` string: The version of the invoice ninja terms that has been accepted by the user - `oauth_user_id` string: The provider id of the oauth entity - `oauth_provider_id` string: The oauth entity id - `language_id` string: The language id of the user - `verified_phone_number` boolean: Boolean flag if the user has their phone verified. Required to settings up 2FA - `sms_verification_code` string: The sms verification code for the user. Required to settings up 2FA - `oauth_user_token_expiry` string: The expiry date of the oauth token - `has_password` boolean: Boolean flag determining if the user has a password - `last_confirmed_email_address` string: The last confirmed email address of the user - `custom_value1` string: A custom value - `custom_value2` string: A custom value - `custom_value3` string: A custom value - `custom_value4` string: A custom value - `is_deleted` boolean: Boolean flag determining if the user has been deleted - `google_2fa_secret` string: The google 2fa secret for the user - `passkey_enabled` boolean: Boolean flag if passkey auth is enabled for this user - `passkey_count` integer: The number of registered passkeys for this user - `oauth_user_refresh_token` string: OAuth refresh token for the user - `oauth_user_token` object: OAuth access token data for the user - `shopify_user_id` string: The unique identifier of the Shopify user - `user_logged_in_notification` boolean: Flag indicating whether to send login notifications - `token` CompanyToken - `name` string: The token name - `token` string: The token value - `is_system` boolean: Determines whether the token is created by the system rather than a user - `client` Client - `id` string: The unique identifier of the client - `contacts` ClientContact[] - `id` string: The hashed if of the contact - `user_id` string: The hashed id of the user who created the contact - `client_id` string: The hashed id of the client - `first_name` string: The first name of the contact - `last_name` string: The last name of the contact - `phone` string: The phone number of the contact - `custom_value1` string: A Custom field value - `custom_value2` string: A Custom field value - `custom_value3` string: A Custom field value - `custom_value4` string: A Custom field value - `email` string: The email of the contact - `accepted_terms_version` string: The terms of service which the contact has accpeted - `password` string: The hashed password of the contact - `confirmation_code` string: The confirmation code used to authenticate the contacts email address - `token` string: A uuid based token. - `contact_key` string: A unique identifier for the contact - `is_primary` boolean: Defines is this contact is the primary contact for the client - `confirmed` boolean: Boolean value confirms the user has confirmed their account. - `is_locked` boolean: Boolean value defines if the contact has been locked out. - `send_email` boolean: Boolean value determines is this contact should receive emails - `cc_only` boolean: When true this contact is only included as a CC recipient on outgoing emails and is not addressed directly. - `can_sign` boolean: When true this contact is permitted to electronically sign invitations (invoices, quotes, credits, purchase orders, recurring invoices). - `failed_logins` number: The number of failed logins the contact has had - `email_verified_at` number: The date which the contact confirmed their email - `last_login` number: Timestamp - `created_at` number: Timestamp - `updated_at` number: Timestamp - `deleted_at` number: Timestamp - `user_id` string: The unique identifier of the user who created the client - `assigned_user_id` string: The unique identifier of the user who has been assigned the client - `name` string: The name of the client company or organization - `website` string: The website URL of the client company or organization - `private_notes` string: Notes that are only visible to the user who created the client - `client_hash` string: A unique hash value for the client - `industry_id` number: The unique identifier of the industry the client operates in - `size_id` number: The unique identifier for the size category of the client company or organization - `address1` string: First line of the client's address - `address2` string: Second line of the client's address, if needed - `city` string: The city the client is located in - `state` string: The state, province, or locality the client is located in - `postal_code` string: The postal code or ZIP code of the client - `phone` string: The client's phone number - `country_id` integer: Available country types: - 4: Afghanistan (AF/AFG) - 8: Albania (AL/ALB) - 10: Antarctica (AQ/ATA) - 12: Algeria (DZ/DZA) - 16: American Samoa (AS/ASM) - 20: Andorra (AD/AND) - 24: Angola (AO/AGO) - 28: Antigua and Barbuda (AG/ATG) - 31: Azerbaijan (AZ/AZE) - 32: Argentina (AR/ARG) - 36: Australia (AU/AUS) - 40: Austria (AT/AUT) - 44: Bahamas (BS/BHS) - 48: Bahrain (BH/BHR) - 50: Bangladesh (BD/BGD) - 51: Armenia (AM/ARM) - 52: Barbados (BB/BRB) - 56: Belgium (BE/BEL) - 60: Bermuda (BM/BMU) - 64: Bhutan (BT/BTN) - 68: Bolivia, Plurinational State of (BO/BOL) - 70: Bosnia and Herzegovina (BA/BIH) - 72: Botswana (BW/BWA) - 74: Bouvet Island (BV/BVT) - 76: Brazil (BR/BRA) - 84: Belize (BZ/BLZ) - 86: British Indian Ocean Territory (IO/IOT) - 90: Solomon Islands (SB/SLB) - 92: Virgin Islands, British (VG/VGB) - 96: Brunei Darussalam (BN/BRN) - 100: Bulgaria (BG/BGR) - 104: Myanmar (MM/MMR) - 108: Burundi (BI/BDI) - 112: Belarus (BY/BLR) - 116: Cambodia (KH/KHM) - 120: Cameroon (CM/CMR) - 124: Canada (CA/CAN) - 132: Cape Verde (CV/CPV) - 136: Cayman Islands (KY/CYM) - 140: Central African Republic (CF/CAF) - 144: Sri Lanka (LK/LKA) - 148: Chad (TD/TCD) - 152: Chile (CL/CHL) - 156: China (CN/CHN) - 158: Taiwan (TW/TWN) - 162: Christmas Island (CX/CXR) - 166: Cocos (Keeling) Islands (CC/CCK) - 170: Colombia (CO/COL) - 174: Comoros (KM/COM) - 175: Mayotte (YT/MYT) - 178: Congo (CG/COG) - 180: Congo, the Democratic Republic of the (CD/COD) - 184: Cook Islands (CK/COK) - 188: Costa Rica (CR/CRI) - 191: Croatia (HR/HRV) - 192: Cuba (CU/CUB) - 196: Cyprus (CY/CYP) - 203: Czech Republic (CZ/CZE) - 204: Benin (BJ/BEN) - 208: Denmark (DK/DNK) - 212: Dominica (DM/DMA) - 214: Dominican Republic (DO/DOM) - 218: Ecuador (EC/ECU) - 222: El Salvador (SV/SLV) - 226: Equatorial Guinea (GQ/GNQ) - 231: Ethiopia (ET/ETH) - 232: Eritrea (ER/ERI) - 233: Estonia (EE/EST) - 234: Faroe Islands (FO/FRO) - 238: Falkland Islands (Malvinas) (FK/FLK) - 239: South Georgia and the South Sandwich Islands (GS/SGS) - 242: Fiji (FJ/FJI) - 246: Finland (FI/FIN) - 248: Åland Islands (AX/ALA) - 250: France (FR/FRA) - 254: French Guiana (GF/GUF) - 258: French Polynesia (PF/PYF) - 260: French Southern Territories (TF/ATF) - 262: Djibouti (DJ/DJI) - 266: Gabon (GA/GAB) - 268: Georgia (GE/GEO) - 270: Gambia (GM/GMB) - 275: Palestine (PS/PSE) - 276: Germany (DE/DEU) - 288: Ghana (GH/GHA) - 292: Gibraltar (GI/GIB) - 296: Kiribati (KI/KIR) - 300: Greece (GR/GRC) - 304: Greenland (GL/GRL) - 308: Grenada (GD/GRD) - 312: Guadeloupe (GP/GLP) - 316: Guam (GU/GUM) - 320: Guatemala (GT/GTM) - 324: Guinea (GN/GIN) - 328: Guyana (GY/GUY) - 332: Haiti (HT/HTI) - 334: Heard Island and McDonald Islands (HM/HMD) - 336: Holy See (Vatican City State) (VA/VAT) - 340: Honduras (HN/HND) - 344: Hong Kong (HK/HKG) - 348: Hungary (HU/HUN) - 352: Iceland (IS/ISL) - 356: India (IN/IND) - 360: Indonesia (ID/IDN) - 364: Iran, Islamic Republic of (IR/IRN) - 368: Iraq (IQ/IRQ) - 372: Ireland (IE/IRL) - 376: Israel (IL/ISR) - 380: Italy (IT/ITA) - 384: Côte d'Ivoire (CI/CIV) - 388: Jamaica (JM/JAM) - 392: Japan (JP/JPN) - 398: Kazakhstan (KZ/KAZ) - 400: Jordan (JO/JOR) - 404: Kenya (KE/KEN) - 408: Korea, Democratic People's Republic of (KP/PRK) - 410: Korea, Republic of (KR/KOR) - 414: Kuwait (KW/KWT) - 417: Kyrgyzstan (KG/KGZ) - 418: Lao People's Democratic Republic (LA/LAO) - 422: Lebanon (LB/LBN) - 426: Lesotho (LS/LSO) - 428: Latvia (LV/LVA) - 430: Liberia (LR/LBR) - 434: Libya (LY/LBY) - 438: Liechtenstein (LI/LIE) - 440: Lithuania (LT/LTU) - 442: Luxembourg (LU/LUX) - 446: Macao (MO/MAC) - 450: Madagascar (MG/MDG) - 454: Malawi (MW/MWI) - 458: Malaysia (MY/MYS) - 462: Maldives (MV/MDV) - 466: Mali (ML/MLI) - 470: Malta (MT/MLT) - 474: Martinique (MQ/MTQ) - 478: Mauritania (MR/MRT) - 480: Mauritius (MU/MUS) - 484: Mexico (MX/MEX) - 492: Monaco (MC/MCO) - 496: Mongolia (MN/MNG) - 498: Moldova, Republic of (MD/MDA) - 499: Montenegro (ME/MNE) - 500: Montserrat (MS/MSR) - 504: Morocco (MA/MAR) - 508: Mozambique (MZ/MOZ) - 512: Oman (OM/OMN) - 516: Namibia (NA/NAM) - 520: Nauru (NR/NRU) - 524: Nepal (NP/NPL) - 528: Netherlands (NL/NLD) - 531: Curaçao (CW/CUW) - 533: Aruba (AW/ABW) - 534: Sint Maarten (Dutch part) (SX/SXM) - 535: Bonaire, Sint Eustatius and Saba (BQ/BES) - 540: New Caledonia (NC/NCL) - 548: Vanuatu (VU/VUT) - 554: New Zealand (NZ/NZL) - 558: Nicaragua (NI/NIC) - 562: Niger (NE/NER) - 566: Nigeria (NG/NGA) - 570: Niue (NU/NIU) - 574: Norfolk Island (NF/NFK) - 578: Norway (NO/NOR) - 580: Northern Mariana Islands (MP/MNP) - 581: United States Minor Outlying Islands (UM/UMI) - 583: Micronesia, Federated States of (FM/FSM) - 584: Marshall Islands (MH/MHL) - 585: Palau (PW/PLW) - 586: Pakistan (PK/PAK) - 591: Panama (PA/PAN) - 598: Papua New Guinea (PG/PNG) - 600: Paraguay (PY/PRY) - 604: Peru (PE/PER) - 608: Philippines (PH/PHL) - 612: Pitcairn (PN/PCN) - 616: Poland (PL/POL) - 620: Portugal (PT/PRT) - 624: Guinea-Bissau (GW/GNB) - 626: Timor-Leste (TL/TLS) - 630: Puerto Rico (PR/PRI) - 634: Qatar (QA/QAT) - 638: Réunion (RE/REU) - 642: Romania (RO/ROU) - 643: Russian Federation (RU/RUS) - 646: Rwanda (RW/RWA) - 652: Saint Barthélemy (BL/BLM) - 654: Saint Helena, Ascension and Tristan da Cunha (SH/SHN) - 659: Saint Kitts and Nevis (KN/KNA) - 660: Anguilla (AI/AIA) - 662: Saint Lucia (LC/LCA) - 663: Saint Martin (French part) (MF/MAF) - 666: Saint Pierre and Miquelon (PM/SPM) - 670: Saint Vincent and the Grenadines (VC/VCT) - 674: San Marino (SM/SMR) - 678: Sao Tome and Principe (ST/STP) - 682: Saudi Arabia (SA/SAU) - 686: Senegal (SN/SEN) - 688: Serbia (RS/SRB) - 690: Seychelles (SC/SYC) - 694: Sierra Leone (SL/SLE) - 702: Singapore (SG/SGP) - 703: Slovakia (SK/SVK) - 704: Viet Nam (VN/VNM) - 705: Slovenia (SI/SVN) - 706: Somalia (SO/SOM) - 710: South Africa (ZA/ZAF) - 716: Zimbabwe (ZW/ZWE) - 724: Spain (ES/ESP) - 728: South Sudan (SS/SSD) - 729: Sudan (SD/SDN) - 732: Western Sahara (EH/ESH) - 740: Suriname (SR/SUR) - 744: Svalbard and Jan Mayen (SJ/SJM) - 748: Swaziland (SZ/SWZ) - 752: Sweden (SE/SWE) - 756: Switzerland (CH/CHE) - 760: Syrian Arab Republic (SY/SYR) - 762: Tajikistan (TJ/TJK) - 764: Thailand (TH/THA) - 768: Togo (TG/TGO) - 772: Tokelau (TK/TKL) - 776: Tonga (TO/TON) - 780: Trinidad and Tobago (TT/TTO) - 784: United Arab Emirates (AE/ARE) - 788: Tunisia (TN/TUN) - 792: Turkey (TR/TUR) - 795: Turkmenistan (TM/TKM) - 796: Turks and Caicos Islands (TC/TCA) - 798: Tuvalu (TV/TUV) - 800: Uganda (UG/UGA) - 804: Ukraine (UA/UKR) - 807: Macedonia, the former Yugoslav Republic of (MK/MKD) - 818: Egypt (EG/EGY) - 826: United Kingdom (GB/GBR) - 831: Guernsey (GG/GGY) - 832: Jersey (JE/JEY) - 833: Isle of Man (IM/IMN) - 834: Tanzania, United Republic of (TZ/TZA) - 840: United States (US/USA) - 850: Virgin Islands, U.S. (VI/VIR) - 854: Burkina Faso (BF/BFA) - 858: Uruguay (UY/URY) - 860: Uzbekistan (UZ/UZB) - 862: Venezuela, Bolivarian Republic of (VE/VEN) - 876: Wallis and Futuna (WF/WLF) - 882: Samoa (WS/WSM) - 887: Yemen (YE/YEM) - 894: Zambia (ZM/ZMB) - `custom_value1` string: A custom field for storing additional information - `custom_value2` string: A custom field for storing additional information - `custom_value3` string: A custom field for storing additional information - `custom_value4` string: A custom field for storing additional information - `vat_number` string: The client's VAT (Value Added Tax) number, if applicable - `id_number` string: A unique identification number for the client, such as a tax ID or business registration number - `number` string: A system-assigned unique number for the client, typically used for invoicing purposes - `shipping_address1` string: First line of the client's shipping address - `shipping_address2` string: Second line of the client's shipping address, if needed - `shipping_city` string: The city of the client's shipping address - `shipping_state` string: The state, province, or locality of the client's shipping address - `shipping_postal_code` string: The postal code or ZIP code of the client's shipping address - `shipping_country_id` number: The unique identifier of the country for the client's shipping address - `is_deleted` boolean: A boolean value indicating whether the client has been deleted or not - `balance` number, float: The outstanding balance the client owes - `paid_to_date` number, float: The total amount the client has paid to date - `credit_balance` number, float: The available credit balance for the client to use on future purchases - `last_login` number: The timestamp of the client's last login - `created_at` number: The timestamp when the client was created - `updated_at` number: The timestamp when the client was last updated - `group_settings_id` string: The group settings assigned to the client - `routing_id` string: The routing address id for e-invoicing for this client - `is_tax_exempt` boolean: Flag which defines if the client is exempt from taxes - `has_valid_vat_number` boolean: Flag which defines if the client has a valid VAT number - `payment_balance` number: Defines the payment balance the client has on file (pre payments / over payments / unapplied amounts) - `settings` ClientSettings - `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` string: options include plain,light,dark,custom - `reply_to_email` string: 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` string: enum when the invoice number counter is set, ie when_saved, when_sent, when_paid - `quote_number_applied` string: enum when the quote number counter is set, ie when_saved, when_sent - `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` boolean: 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 - `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: 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` number: Taxes 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: The tax rate (float) - `tax_name1` string: The tax name - `tax_rate2` number: The tax rate (float) - `tax_name2` string: The tax name - `tax_rate3` number: 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` string: The email driver to use to send email, options include default, gmail - `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` object: The company logo file - `website` string: 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: 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` number: The Reminder interval - `num_days_reminder2` number: The Reminder interval - `num_days_reminder3` number: The Reminder interval - `schedule_reminder1` string: (enum: after_invoice_date, before_due_date, after_due_date) - `schedule_reminder2` string: (enum: after_invoice_date, before_due_date, after_due_date) - `schedule_reminder3` string: (enum: after_invoice_date, before_due_date, after_due_date) - `late_fee_amount1` number: The late fee amount for reminder 1 - `late_fee_amount2` number: The late fee amount for reminder 2 - `late_fee_amount3` number: 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` string: 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: 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: 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` number: 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` string: 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` number: The counter for purchase order numbers - `page_numbering_alignment` string: 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` boolean: 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` number: The counter for recurring invoice numbers - `client_portal_under_payment_minimum` number: The minimum payment payment - `auto_bill_date` string: Determines when the invoices are auto billed, options are on_send_date (when the invoice is sent) or on_due_date (when the invoice is due)) - `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` string: Determines how autobilling is applied for recurring invoices. off (no auto billed), always (always auto bill), optin (The user must opt in to auto billing), optout (The user must opt out of auto billing - `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: The late fee percentage for endless late fees - `late_fee_endless_amount` number: 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: Classification or category label for organizational purposes - `public_notes` string: Notes that are visible to the client - `contact` ClientContact - `id` string: The hashed if of the contact - `user_id` string: The hashed id of the user who created the contact - `client_id` string: The hashed id of the client - `first_name` string: The first name of the contact - `last_name` string: The last name of the contact - `phone` string: The phone number of the contact - `custom_value1` string: A Custom field value - `custom_value2` string: A Custom field value - `custom_value3` string: A Custom field value - `custom_value4` string: A Custom field value - `email` string: The email of the contact - `accepted_terms_version` string: The terms of service which the contact has accpeted - `password` string: The hashed password of the contact - `confirmation_code` string: The confirmation code used to authenticate the contacts email address - `token` string: A uuid based token. - `contact_key` string: A unique identifier for the contact - `is_primary` boolean: Defines is this contact is the primary contact for the client - `confirmed` boolean: Boolean value confirms the user has confirmed their account. - `is_locked` boolean: Boolean value defines if the contact has been locked out. - `send_email` boolean: Boolean value determines is this contact should receive emails - `cc_only` boolean: When true this contact is only included as a CC recipient on outgoing emails and is not addressed directly. - `can_sign` boolean: When true this contact is permitted to electronically sign invitations (invoices, quotes, credits, purchase orders, recurring invoices). - `failed_logins` number: The number of failed logins the contact has had - `email_verified_at` number: The date which the contact confirmed their email - `last_login` number: Timestamp - `created_at` number: Timestamp - `updated_at` number: Timestamp - `deleted_at` number: Timestamp - `recurring_invoice` RecurringInvoice - `id` string: The hashed id of the recurring invoice - `user_id` string: The user hashed id - `assigned_user_id` string: The assigned user hashed id - `client_id` string: The client hashed id - `status_id` string: The invoice status variable - `frequency_id` number: The recurring invoice frequency - `remaining_cycles` number: The number of invoices left to be generated - `number` string: The recurringinvoice number - is a unique alpha numeric number per invoice per company - `po_number` string: The purchase order associated with this recurring invoice - `terms` string: The invoice terms - `public_notes` string: The public notes of the invoice - `private_notes` string: The private notes of the invoice - `footer` string: The invoice footer notes - `custom_value1` string: A custom field value - `custom_value2` string: A custom field value - `custom_value3` string: A custom field value - `custom_value4` string: A custom field value - `tax_name1` string: The tax name - `tax_name2` string: The tax name - `tax_rate1` number, float: The tax rate - `tax_rate2` number, float: The tax rate - `tax_name3` string: The tax name - `tax_rate3` number, float: The tax rate - `total_taxes` number, float: The total taxes for the invoice - `line_items` object: An array of objects which define the line items of the invoice - `amount` number, float: The invoice amount - `balance` number, float: The invoice balance - `paid_to_date` number, float: The amount paid on the invoice to date - `discount` number, float: The invoice discount, can be an amount or a percentage - `partial` number, float: The deposit/partial amount - `is_amount_discount` boolean: Flag determining if the discount is an amount or a percentage - `is_deleted` boolean: Defines if the invoice has been deleted - `uses_inclusive_taxes` boolean: Defines the type of taxes used as either inclusive or exclusive - `date` string, date: The Invoice Date - `last_sent_date` string, date: The last date the invoice was sent out - `next_send_date` string, date: The Next date for a reminder to be sent - `partial_due_date` string, date: The due date for the deposit/partial amount - `due_date` string, date: The due date of the invoice - `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 - `last_viewed` number: Timestamp - `updated_at` number: Timestamp - `archived_at` number: Timestamp - `custom_surcharge1` number, float: First Custom Surcharge - `custom_surcharge2` number, float: Second Custom Surcharge - `custom_surcharge3` number, float: Third Custom Surcharge - `custom_surcharge4` number, float: Fourth Custom Surcharge - `custom_surcharge_tax1` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax2` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax3` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax4` boolean: Toggles charging taxes on custom surcharge amounts - `location_id` string: The client location id that this invoice relates to - `auto_bill` string: Auto-billing configuration setting - `auto_bill_enabled` boolean: Flag indicating whether auto-billing is enabled - `design_id` string: The unique identifier of the design template used for this recurring invoice - `due_date_days` integer: Number of days until the due date - `e_invoice` object: E-invoice configuration and data - `exchange_rate` number, float: The exchange rate used for currency conversion - `next_send_date_client` string, date: The next scheduled send date for the client - `project_id` string: The unique identifier of the project associated with this recurring invoice - `vendor_id` string: The unique identifier of the vendor associated with this recurring invoice - `invoice` Invoice - `id` string: The invoice hashed id - `user_id` string: The user hashed id - `assigned_user_id` string: The assigned user hashed id - `client_id` string: The client hashed id - `status_id` string: The invoice status variable - `number` string: The invoice number - is a unique alpha numeric number per invoice per company - `po_number` string: The purchase order associated with this invoice - `terms` string: The invoice terms - `public_notes` string: The public notes of the invoice - `private_notes` string: The private notes of the invoice - `footer` string: The invoice footer notes - `custom_value1` string: A custom field value - `custom_value2` string: A custom field value - `custom_value3` string: A custom field value - `custom_value4` string: A custom field value - `tax_name1` string: The tax name - `tax_name2` string: The tax name - `tax_rate1` number, float: The tax rate - `tax_rate2` number, float: The tax rate - `tax_name3` string: The tax name - `tax_rate3` number, float: The tax rate - `total_taxes` number, float: The total taxes for the invoice - `line_items` InvoiceItem[]: An array of objects which define the line items of the invoice - `quantity` number: The quantity of the product offered for this line item - `cost` number, float: The cost of the product offered for this line item - `product_key` string: The product key of the product offered for this line item (Referred to as Product in the product tab) - `tags` string: A comma-separated snapshot of the product tag names for this line item - `product_cost` number, float: The cost of the product offered for this line item (Referred to as Cost in the product tab) - `notes` string: The notes/description for the product offered for this line item - `discount` number, float: The discount applied to the product offered for this line item - `is_amount_discount` boolean: Indicates whether the discount applied to the product offered for this line item is a fixed amount or a percentage - `tax_name1` string: The name of the first tax applied to the product offered for this line item - `tax_rate1` number, float: The rate of the first tax applied to the product offered for this line item - `tax_name2` string: The name of the second tax applied to the product offered for this line item - `tax_rate2` number, float: The rate of the second tax applied to the product offered for this line item - `tax_name3` string: The name of the third tax applied to the product offered for this line item - `tax_rate3` number, float: The rate of the third tax applied to the product offered for this line item - `sort_id` string: Deprecated - `line_total` number, float: The total amount of the product offered for this line item - `gross_line_total` number, float: The total amount of the product offered for this line item before discounts - `tax_amount` number, float: The total amount of tax applied to the product offered for this line item - `custom_value1` string: The first custom value of the product offered for this line item - `custom_value2` string: The second custom value of the product offered for this line item - `custom_value3` string: The third custom value of the product offered for this line item - `custom_value4` string: The fourth custom value of the product offered for this line item - `type_id` string: 1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense - `tax_id` string: The tax ID of the product: 1 product, 2 service, 3 digital, 4 shipping, 5 exempt, 5 reduced tax, 7 override, 8 zero rate, 9 reverse tax - `invitations` InvoiceInvitation[]: An array of objects which define the invitations of the invoice - `id` string: The entity invitation hashed id - `client_contact_id` string: The client contact hashed id - `key` string: The invitation key - `link` string: The invitation link - `sent_date` string, date-time: The invitation sent date - `viewed_date` string, date-time: The invitation viewed date - `opened_date` string, date-time: The invitation opened date - `updated_at` number: Timestamp - `archived_at` number: Timestamp - `email_error` string: The email error - `email_status` string: The email status - `can_sign` boolean: Indicates whether the recipient contact may electronically sign this invitation. Mirrors the can_sign flag on the linked client contact at the time the invitation was issued. - `amount` number, float: The invoice amount - `balance` number, float: The invoice balance - `paid_to_date` number, float: The amount paid on the invoice to date - `discount` number, float: The invoice discount, can be an amount or a percentage - `partial` number, float: The deposit/partial amount - `is_amount_discount` boolean: Flag determining if the discount is an amount or a percentage - `is_deleted` boolean: Defines if the invoice has been deleted - `uses_inclusive_taxes` boolean: Defines the type of taxes used as either inclusive or exclusive - `date` string, date: The Invoice Date - `last_sent_date` string, date: The last date the invoice was sent out - `next_send_date` string, date: The Next date for a reminder to be sent - `partial_due_date` string, date: The due date for the deposit/partial amount - `due_date` string, date: The due date of the invoice - `last_viewed` number: Timestamp - `updated_at` number: Timestamp - `archived_at` number: Timestamp - `custom_surcharge1` number, float: First Custom Surcharge - `custom_surcharge2` number, float: Second Custom Surcharge - `custom_surcharge3` number, float: Third Custom Surcharge - `custom_surcharge4` number, float: Fourth Custom Surcharge - `custom_surcharge_tax1` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax2` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax3` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax4` boolean: Toggles charging taxes on custom surcharge amounts - `project_id` string: The project associated with this invoice - `auto_bill_tries` integer: The number of times the invoice has attempted to be auto billed - `auto_bill_enabled` boolean: Boolean flag determining if the invoice is set to auto bill - `subscription_id` string: The subscription associated with this invoice - `location_id` string: The client location id that this invoice relates to - `design_id` string: The unique identifier of the design template used for this invoice - `e_invoice` object: E-invoice configuration and data - `exchange_rate` number, float: The exchange rate used for currency conversion - `vendor_id` string: The unique identifier of the vendor associated with this invoice - `credit` Credit - `id` string: The unique hashed ID of the credit - `user_id` string: The unique hashed ID of the user associated with the credit - `assigned_user_id` string: The unique hashed ID of the assigned user responsible for the credit - `client_id` string: The unique hashed ID of the client associated with the credit - `status_id` string: The ID representing the current status of the credit - `invoice_id` string: The unique hashed ID of the linked invoice to which the credit is applied - `number` string: The unique alphanumeric credit number per company - `po_number` string: The purchase order number referred to by the credit - `terms` string: The terms associated with the credit - `public_notes` string: Public notes for the credit - `private_notes` string: Private notes for internal use, not visible to the client - `footer` string: The footer text for the credit - `custom_value1` string: Custom value 1 for additional credit information - `custom_value2` string: Custom value 2 for additional credit information - `custom_value3` string: Custom value 3 for additional credit information - `custom_value4` string: Custom value 4 for additional credit information - `tax_name1` string: The name of the first tax applied to the credit - `tax_name2` string: The name of the second tax applied to the credit - `tax_rate1` number, float: The rate of the first tax applied to the credit - `tax_rate2` number, float: The rate of the second tax applied to the credit - `tax_name3` string: The name of the third tax applied to the credit - `tax_rate3` number, float: The rate of the third tax applied to the credit - `total_taxes` number, float: The total amount of taxes for the credit - `line_items` InvoiceItem[]: An array of objects which define the line items of the credit - `quantity` number: The quantity of the product offered for this line item - `cost` number, float: The cost of the product offered for this line item - `product_key` string: The product key of the product offered for this line item (Referred to as Product in the product tab) - `tags` string: A comma-separated snapshot of the product tag names for this line item - `product_cost` number, float: The cost of the product offered for this line item (Referred to as Cost in the product tab) - `notes` string: The notes/description for the product offered for this line item - `discount` number, float: The discount applied to the product offered for this line item - `is_amount_discount` boolean: Indicates whether the discount applied to the product offered for this line item is a fixed amount or a percentage - `tax_name1` string: The name of the first tax applied to the product offered for this line item - `tax_rate1` number, float: The rate of the first tax applied to the product offered for this line item - `tax_name2` string: The name of the second tax applied to the product offered for this line item - `tax_rate2` number, float: The rate of the second tax applied to the product offered for this line item - `tax_name3` string: The name of the third tax applied to the product offered for this line item - `tax_rate3` number, float: The rate of the third tax applied to the product offered for this line item - `sort_id` string: Deprecated - `line_total` number, float: The total amount of the product offered for this line item - `gross_line_total` number, float: The total amount of the product offered for this line item before discounts - `tax_amount` number, float: The total amount of tax applied to the product offered for this line item - `custom_value1` string: The first custom value of the product offered for this line item - `custom_value2` string: The second custom value of the product offered for this line item - `custom_value3` string: The third custom value of the product offered for this line item - `custom_value4` string: The fourth custom value of the product offered for this line item - `type_id` string: 1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense - `tax_id` string: The tax ID of the product: 1 product, 2 service, 3 digital, 4 shipping, 5 exempt, 5 reduced tax, 7 override, 8 zero rate, 9 reverse tax - `invitations` CreditInvitation[]: An array of objects which define the invitations of the credit - `id` string: The entity invitation hashed id - `client_contact_id` string: The client contact hashed id - `key` string: The invitation key - `link` string: The invitation link - `sent_date` string, date-time: The invitation sent date - `viewed_date` string, date-time: The invitation viewed date - `opened_date` string, date-time: The invitation opened date - `updated_at` number: Timestamp - `archived_at` number: Timestamp - `email_error` string: The email error - `email_status` string: The email status - `can_sign` boolean: Indicates whether the recipient contact may electronically sign this invitation. Mirrors the can_sign flag on the linked client contact at the time the invitation was issued. - `amount` number, float: The total amount of the credit - `balance` number, float: The outstanding balance of the credit - `paid_to_date` number, float: The total amount paid to date for the credit - `discount` number, float: The discount applied to the credit - `partial` number, float: The partial amount applied to the credit - `is_amount_discount` boolean: Indicates whether the discount applied is a fixed amount or a percentage - `is_deleted` boolean: Indicates whether the credit has been deleted - `uses_inclusive_taxes` boolean: Indicates whether the tax rates applied to the credit are inclusive or exclusive - `date` string, date: The date the credit was issued - `last_sent_date` string, date: The date the credit was last sent out - `next_send_date` string, date: The next scheduled date for sending a credit reminder - `partial_due_date` string, date: The due date for the partial amount of the credit - `due_date` string, date: The due date for the total amount of the credit - `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 - `last_viewed` number: The timestamp of the last time the credit was viewed - `updated_at` number: The timestamp of the last time the credit was updated - `archived_at` number: The timestamp of the last time the credit was archived - `custom_surcharge1` number, float: First custom surcharge amount - `custom_surcharge2` number, float: Second Custom Surcharge - `custom_surcharge3` number, float: Third Custom Surcharge - `custom_surcharge4` number, float: Fourth Custom Surcharge - `custom_surcharge_tax1` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax2` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax3` boolean: Toggles charging taxes on custom surcharge amounts - `custom_surcharge_tax4` boolean: Toggles charging taxes on custom surcharge amounts - `location_id` string: The client location id that this invoice relates to - `design_id` string: The unique identifier of the design template used for this credit - `exchange_rate` number, float: The exchange rate used for currency conversion - `project_id` string: The unique identifier of the project associated with this credit - `subscription_id` string: The unique identifier of the subscription associated with this credit - `vendor_id` string: The unique identifier of the vendor associated with this credit - `quote` Quote - `id` string: The unique hashed identifier for the quote - `user_id` string: The unique hashed identifier for the user who created the quote - `assigned_user_id` string: The unique hashed identifier for the user assigned to the quote - `client_id` string: The unique hashed identifier for the client associated with the quote - `status_id` string: The status of the quote represented by a unique identifier - `number` string: The unique alpha-numeric quote number for the quote per company - `po_number` string: The purchase order number associated with the quote - `terms` string: The terms and conditions for the quote - `public_notes` string: Publicly visible notes associated with the quote - `private_notes` string: Privately visible notes associated with the quote, not disclosed to the client - `footer` string: The footer text of the quote - `custom_value1` string: First custom value field for additional information - `custom_value2` string: Second custom value field for additional information - `custom_value3` string: Third custom value field for additional information - `custom_value4` string: Fourth custom value field for additional information - `tax_name1` string: The name of the first tax applied to the quote - `tax_name2` string: The name of the second tax applied to the quote - `tax_rate1` number, float: The rate of the first tax applied to the quote - `tax_rate2` number, float: The rate of the second tax applied to the quote - `tax_name3` string: The name of the third tax applied to the quote - `tax_rate3` number, float: The rate of the third tax applied to the quote - `total_taxes` number, float: The total amount of taxes for the quote - `line_items` InvoiceItem[]: An array of objects which define the line items of the quote - `quantity` number: The quantity of the product offered for this line item - `cost` number, float: The cost of the product offered for this line item - `product_key` string: The product key of the product offered for this line item (Referred to as Product in the product tab) - `tags` string: A comma-separated snapshot of the product tag names for this line item - `product_cost` number, float: The cost of the product offered for this line item (Referred to as Cost in the product tab) - `notes` string: The notes/description for the product offered for this line item - `discount` number, float: The discount applied to the product offered for this line item - `is_amount_discount` boolean: Indicates whether the discount applied to the product offered for this line item is a fixed amount or a percentage - `tax_name1` string: The name of the first tax applied to the product offered for this line item - `tax_rate1` number, float: The rate of the first tax applied to the product offered for this line item - `tax_name2` string: The name of the second tax applied to the product offered for this line item - `tax_rate2` number, float: The rate of the second tax applied to the product offered for this line item - `tax_name3` string: The name of the third tax applied to the product offered for this line item - `tax_rate3` number, float: The rate of the third tax applied to the product offered for this line item - `sort_id` string: Deprecated - `line_total` number, float: The total amount of the product offered for this line item - `gross_line_total` number, float: The total amount of the product offered for this line item before discounts - `tax_amount` number, float: The total amount of tax applied to the product offered for this line item - `custom_value1` string: The first custom value of the product offered for this line item - `custom_value2` string: The second custom value of the product offered for this line item - `custom_value3` string: The third custom value of the product offered for this line item - `custom_value4` string: The fourth custom value of the product offered for this line item - `type_id` string: 1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense - `tax_id` string: The tax ID of the product: 1 product, 2 service, 3 digital, 4 shipping, 5 exempt, 5 reduced tax, 7 override, 8 zero rate, 9 reverse tax - `amount` number, float: The total amount of the quote before taxes and discounts - `balance` number, float: The balance due for the quote after accounting for payments - `paid_to_date` number, float: The total amount paid on the quote so far - `discount` number, float: The discount amount or percentage applied to the quote - `partial` number, float: The partial or deposit amount for the quote - `is_amount_discount` boolean: Boolean flag indicating if the discount is a fixed amount or a percentage - `is_deleted` boolean: Boolean flag indicating if the quote has been deleted - `uses_inclusive_taxes` boolean: Boolean flag indicating if the taxes used are inclusive or exclusive - `date` string, date: The date the quote was created - `last_sent_date` string, date: The last date the quote was sent to the client - `next_send_date` string, date: The next scheduled date for sending a reminder for the quote - `partial_due_date` string, date: The due date for the partial or deposit amount - `due_date` string, date: The due date for the total amount of the quote - `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 - `last_viewed` number: The timestamp of the last time the quote was viewed - `updated_at` number: The timestamp of the last update to the quote - `archived_at` number: The timestamp of when the quote was archived - `custom_surcharge1` number, float: First custom surcharge amount for the quote - `custom_surcharge2` number, float: Second custom surcharge amount for the quote - `custom_surcharge3` number, float: Third custom surcharge amount for the quote - `custom_surcharge4` number, float: Fourth custom surcharge amount for the quote - `custom_surcharge_tax1` boolean: Boolean flag indicating if taxes are charged on the first custom surcharge amount - `custom_surcharge_tax2` boolean: Boolean flag indicating if taxes are charged on the second custom surcharge amount - `custom_surcharge_tax3` boolean: Boolean flag indicating if taxes are charged on the third custom surcharge amount - `custom_surcharge_tax4` boolean: Boolean flag indicating if taxes are charged on the fourth custom surcharge amount - `location_id` string: The client location id that this invoice relates to - `design_id` string: The unique identifier of the design template used for this quote - `exchange_rate` number, float: The exchange rate used for currency conversion - `project_id` string: The unique identifier of the project associated with this quote - `subscription_id` string: The unique identifier of the subscription associated with this quote - `vendor_id` string: The unique identifier of the vendor associated with this quote - `payment` Payment - `id` string: The payment hashed id - `client_id` string: The client hashed id - `invitation_id` string: The invitation hashed id - `client_contact_id` string: The client contact hashed id - `user_id` string: The user hashed id - `type_id` '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33': The payment type used to complete this payment - `date` string: The Payment date - `transaction_reference` string: The transaction reference as defined by the payment gateway - `assigned_user_id` string: The assigned user hashed id - `private_notes` string: The private notes of the payment - `is_manual` boolean: Flags whether the payment was made manually or processed via a gateway - `is_deleted` boolean: Defines if the payment has been deleted - `amount` number: The amount of this payment - `refunded` number: The refunded amount of this payment - `updated_at` number: Timestamp - `archived_at` number: Timestamp - `company_gateway_id` string: The company gateway id - `paymentables` Paymentable - `id` string: The paymentable hashed id - `invoice_id` string: The invoice hashed id - `credit_id` string: The credit hashed id - `refunded` number, float: The amount that has been refunded for this payment - `amount` number, float: The amount that has been applied to the payment - `updated_at` number: Timestamp - `created_at` number: Timestamp - `invoices` InvoicePaymentable[] - `invoice_id` string: ______ - `amount` string: ______ - `credits` CreditPaymentable[] - `credit_id` string: The credit hashed id - `amount` string: The credit amount - `number` string: The payment number - is a unique alpha numeric number per payment per company - `category_id` string: The unique identifier of the payment category - `custom_value1` string: Custom field for storing additional information - `custom_value2` string: Custom field for storing additional information - `custom_value3` string: Custom field for storing additional information - `custom_value4` string: Custom field for storing additional information - `exchange_currency_id` string: The unique identifier of the exchange currency - `exchange_rate` number, float: The exchange rate used for currency conversion - `idempotency_key` string: Unique key to ensure idempotent payment processing - `expense` Expense - `id` string: The expense hashed id - `user_id` string: The user hashed id - `assigned_user_id` string: The assigned user hashed id - `project_id` string: The associated project_id - `client_id` string: The client hashed id - `invoice_id` string: The related invoice hashed id - `bank_id` string: The bank id related to this expense - `invoice_currency_id` string: The currency id of the related invoice - `currency_id` string: The currency id of the expense - `invoice_category_id` string: The invoice category id - `payment_type_id` string: The payment type id - `recurring_expense_id` string: The related recurring expense this expense was created from - `private_notes` string: The private notes of the expense - `public_notes` string: The public notes of the expense - `transaction_reference` string: The transaction references of the expense - `transcation_id` string: The transaction id of the expense - `custom_value1` string: A custom value - `custom_value2` string: A custom value - `custom_value3` string: A custom value - `custom_value4` string: A custom value - `tax_amount` number: The tax amount - `tax_name1` string: Tax Name 1 - `tax_name2` string: Tax Name 2 - `tax_name3` string: Tax Name 3 - `tax_rate1` number, float: Tax rate 1 - `tax_rate2` number, float: Tax rate 2 - `tax_rate3` number, float: Tax rate 3 - `amount` number, float: The total expense amont - `foreign_amount` number, float: The total foreign amount of the expense - `exchange_rate` number, float: The exchange rate at the time of the expense - `date` string: The expense date format Y-m-d - `payment_date` string: The date of payment for the expense, format Y-m-d - `should_be_invoiced` boolean: Flag whether the expense should be invoiced - `is_deleted` boolean: Boolean determining whether the expense has been deleted - `invoice_documents` boolean: Passing the expense documents over to the invoice - `updated_at` number: Timestamp - `archived_at` number: Timestamp - `calculate_tax_by_amount` boolean: Flag indicating whether to calculate tax based on amount rather than percentage - `category_id` string: The unique identifier of the expense category - `number` string: The unique number assigned to this expense - `purchase_order_id` string: The unique identifier of the associated purchase order - `tax_amount1` number, float: The amount of the first tax - `tax_amount2` number, float: The amount of the second tax - `tax_amount3` number, float: The amount of the third tax - `transaction_id` string: The unique identifier of the transaction - `uses_inclusive_taxes` boolean: Flag indicating whether taxes are included in the price - `vendor_id` string: The unique identifier of the vendor associated with this expense - `task` Task - `id` string: The hashed id of the task - `user_id` string: The hashed id of the user who created the task - `assigned_user_id` string: The assigned user of the task - `client_id` string: The hashed if of the client - `invoice_id` string: The hashed id of the invoice associated with the task - `project_id` string: The hashed id of the project associated with the task - `number` string: The number of the task - `time_log` string: An array of unix time stamps defining the start and end times of the task - `is_running` boolean: Determines if the task is still running - `is_deleted` boolean: Boolean flag determining if the task has been deleted - `task_status_id` string: The hashed id of the task status - `description` string: The task description - `duration` integer: The task duration in seconds - `task_status_order` integer: The order of the task - `rate` number: The task rate - `custom_value1` string: A custom value - `custom_value2` string: A custom value - `custom_value3` string: A custom value - `custom_value4` string: A custom value - `is_date_based` boolean: Boolean flag determining if the task is date based - `calculated_start_date` string: The calculated start date of the task - `invoice_documents` boolean: Boolean flags which determines whether to include the task documents on the invoice - `created_at` number: Timestamp - `updated_at` number: Timestamp - `archived_at` number: Timestamp - `hash` string: Unique hash identifier for this task - `meta` object: Metadata associated with this task - `status_id` string: The unique identifier of the task status - `status_order` integer: Sort order for status display - `status_sort_order` integer: Alternative sort order for status - `tags` TagAssignment[]: Tags assigned to the task - `id` string, required: The hashed tag id - `name` string, required: The tag name - `color` string, nullable: The tag color as a hex value, or null when unset - `purchase_order` PurchaseOrder - `id` string: The unique hashed identifier for the purchase order - `user_id` string: The unique hashed identifier for the user who created the purchase order - `assigned_user_id` string: The unique hashed identifier for the user assigned to the purchase order - `vendor_id` string: The unique hashed identifier for the vendor associated with the purchase order - `status_id` string: The status of the purchase order represented by a unique identifier - `number` string: The unique alpha-numeric purchase order number per company - `quote_number` string: The quote number associated with this purchase order - `terms` string: The terms and conditions for the purchase order - `public_notes` string: Publicly visible notes associated with the purchase order - `private_notes` string: Privately visible notes associated with the purchase order, not disclosed to the vendor - `footer` string: The footer text of the purchase order - `custom_value1` string: First custom value field for additional information - `custom_value2` string: Second custom value field for additional information - `custom_value3` string: Third custom value field for additional information - `custom_value4` string: Fourth custom value field for additional information - `tax_name1` string: The name of the first tax applied to the purchase order - `tax_name2` string: The name of the second tax applied to the purchase order - `tax_rate1` number, float: The rate of the first tax applied to the purchase order - `tax_rate2` number, float: The rate of the second tax applied to the purchase order - `tax_name3` string: The name of the third tax applied to the purchase order - `tax_rate3` number, float: The rate of the third tax applied to the purchase order - `total_taxes` number, float: The total amount of taxes applied to the purchase order - `line_items` InvoiceItem[]: An array of objects which define the line items of the purchase order - `quantity` number: The quantity of the product offered for this line item - `cost` number, float: The cost of the product offered for this line item - `product_key` string: The product key of the product offered for this line item (Referred to as Product in the product tab) - `tags` string: A comma-separated snapshot of the product tag names for this line item - `product_cost` number, float: The cost of the product offered for this line item (Referred to as Cost in the product tab) - `notes` string: The notes/description for the product offered for this line item - `discount` number, float: The discount applied to the product offered for this line item - `is_amount_discount` boolean: Indicates whether the discount applied to the product offered for this line item is a fixed amount or a percentage - `tax_name1` string: The name of the first tax applied to the product offered for this line item - `tax_rate1` number, float: The rate of the first tax applied to the product offered for this line item - `tax_name2` string: The name of the second tax applied to the product offered for this line item - `tax_rate2` number, float: The rate of the second tax applied to the product offered for this line item - `tax_name3` string: The name of the third tax applied to the product offered for this line item - `tax_rate3` number, float: The rate of the third tax applied to the product offered for this line item - `sort_id` string: Deprecated - `line_total` number, float: The total amount of the product offered for this line item - `gross_line_total` number, float: The total amount of the product offered for this line item before discounts - `tax_amount` number, float: The total amount of tax applied to the product offered for this line item - `custom_value1` string: The first custom value of the product offered for this line item - `custom_value2` string: The second custom value of the product offered for this line item - `custom_value3` string: The third custom value of the product offered for this line item - `custom_value4` string: The fourth custom value of the product offered for this line item - `type_id` string: 1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense - `tax_id` string: The tax ID of the product: 1 product, 2 service, 3 digital, 4 shipping, 5 exempt, 5 reduced tax, 7 override, 8 zero rate, 9 reverse tax - `amount` number, float: The total amount of the purchase order before taxes and discounts - `balance` number, float: The balance due for the purchase order after accounting for payments - `paid_to_date` number, float: The total amount paid on the purchase order so far - `discount` number, float: The discount amount or percentage applied to the purchase order - `partial` number, float: The partial or deposit amount for the purchase order - `is_amount_discount` boolean: Boolean flag indicating if the discount is a fixed amount or a percentage - `is_deleted` boolean: Boolean flag indicating if the purchase order has been deleted - `uses_inclusive_taxes` boolean: Boolean flag indicating if the taxes used are inclusive or exclusive - `date` string, date: The date the purchase order was created - `last_sent_date` string, date: The last date the purchase order was sent to the vendor - `next_send_date` string, date: The next scheduled date for sending a reminder for the purchase order - `partial_due_date` string, date: The due date for the partial or deposit amount - `due_date` string, date: The due date for the total amount of the purchase order - `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 - … truncated; see the full OpenAPI document linked below ## Other responses - `401`: Authentication error - `403`: Authorization error - `422`: Validation error - `default`: Unexpected Error ## Changes > 110 revisions in range; 1 not diffed. - **2026-09-08** `bcda1f823746`: 1 info - added the optional property `data/items/purchase_order/quote_id` to the response with the `200` status - **2026-08-21** `a8b7a375e4ed`: 4 info - added the optional property `data/items/credit/line_items/items/tags` to the response with the `200` status - added the optional property `data/items/invoice/line_items/items/tags` to the response with the `200` status - added the optional property `data/items/purchase_order/line_items/items/tags` to the response with the `200` status - added the optional property `data/items/quote/line_items/items/tags` to the response with the `200` status - **2026-05-31** `28befcbfadda`: 1 breaking - the response property `data/items/task/tags/items/color` became optional for the status `200` - **2026-05-31** `edde330209e2`: 1 info - added the optional property `data/items/task/tags` to the response with the `200` status - **2026-04-20** `69a36036d334`: 21 info - added the optional property `data/items/client/contacts/items/can_sign` to the response with the `200` status - added the optional property `data/items/client/contacts/items/cc_only` to the response with the `200` status - added the optional property `data/items/contact/can_sign` to the response with the `200` status - added the optional property `data/items/contact/cc_only` to the response with the `200` status - …17 more [Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/activities/get.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)