INinvoiceninja
refresh

Refresh data by timestamp

Changed on

Refreshes the dataset.

This endpoint can be used if you only need to access the most recent data from a certain point in time. For example, if you only want to retrieve The most recent data from the last time you accessed the system, you would pass the query parameter ?updated_at=1676173763. (unix timestamp)

post/api/v1/refresh

Request

Query parameters

updated_atnumber required

The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data.

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

include_staticstring
Example:include_static=true

This include will return the full set of static variables used in the application including:

  • Currencies
  • Countries
  • Languages
  • Payment Types
  • Email Templatees
  • Industries
clear_cachestring
Example:clear_cache=true

Clears cache

Clears (and rebuilds) the static variable cache.

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

The Company User response

permissionsstring

The user permissions for this company in a comma separated list

settingsobject

Settings that are used for the flutter applications to store user preferences / metadata

react_settingsobject

Dedicated settings object for the react web application

is_ownerboolean

Determines whether the user owns this company

is_adminboolean

Determines whether the user is the admin of this company

is_lockedboolean

Determines whether the users access to this company has been locked

updated_atinteger

The last time the record was modified, format Unix Timestamp

deleted_atinteger

Timestamp when the user was archived, format Unix Timestamp

Example response

{
  "permissions": "create_invoice,create_client,view_client",
  "is_owner": true,
  "is_admin": true,
  "is_locked": true,
  "updated_at": 1231232312321,
  "deleted_at": 12312312321,
  "account": {
    "id": "AS3df3A",
    "account_sms_verified": "true"
  },
  "company": {
    "id": "WJxbojagwO",
    "size_id": "2",
    "industry_id": "5",
    "slack_webhook_url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
    "google_analytics_key": "UA-123456789-1",
    "portal_mode": "subdomain",
    "subdomain": "acme",
    "portal_domain": "https://subdomain.invoicing.co",
    "enabled_tax_rates": 2,
    "fill_products": true,
    "convert_products": true,
    "update_products": true,
    "show_product_details": true,
    "show_product_cost": true,
    "enable_product_cost": true,
    "enable_product_quantity": true,
    "default_quantity": true,
    "custom_surcharge_taxes1": true,
    "custom_surcharge_taxes2": true,
    "custom_surcharge_taxes3": true,
    "logo": "logo.png",
    "company_key": "Vnb14bRlwiFjc5ckte6cfbygTRkn5IMQ",
    "client_can_register": true,
    "enabled_modules": 2048,
    "db": "db-ninja-01",
    "first_day_of_week": "1",
    "first_month_of_year": "1",
    "enabled_item_tax_rates": 2,
    "is_large": true,
    "default_auto_bill": "always",
    "mark_expenses_invoiceable": true,
    "mark_expenses_paid": true,
    "invoice_expense_documents": true,
    "auto_start_tasks": true,
    "invoice_task_timelog": true,
    "invoice_task_documents": true,
    "show_tasks_table": true,
    "is_disabled": true,
    "default_task_is_date_based": true,
    "enable_product_discount": true,
    "calculate_expense_tax_by_amount": true,
    "expense_inclusive_taxes": true,
    "session_timeout": 60,
    "oauth_password_required": true,
    "invoice_task_datelog": true,
    "default_password_timeout": 60,
    "show_task_end_date": true,
    "markdown_enabled": true,
    "report_include_drafts": true,
    "stop_on_unpaid_recurring": true,
    "use_quote_terms_on_conversion": true,
    "enable_applying_payments": true,
    "track_inventory": true,
    "inventory_notification_threshold": 60,
    "stock_notification": true,
    "matomo_url": "https://matomo.example.com",
    "matomo_id": "1",
    "enabled_expense_tax_rates": 2,
    "invoice_task_project": true,
    "report_include_deleted": true,
    "invoice_task_lock": true,
    "convert_payment_currency": true,
    "convert_expense_currency": true,
    "notify_vendor_when_paid": true,
    "invoice_task_hours": true,
    "calculate_taxes": true,
    "e_invoice_certificate": "-----BEGIN CERTIFICATE-----",
    "e_invoice_certificate_passphrase": "secret",
    "invoice_task_project_header": true,
    "invoice_task_item_description": true,
    "expense_mailbox": "expenses@company.com",
    "expense_mailbox_active": true,
    "inbound_mailbox_allow_company_users": true,
    "inbound_mailbox_allow_clients": true,
    "inbound_mailbox_whitelist": "user1@example.com,user2@example.com",
    "inbound_mailbox_blacklist": "spam@example.com,unwanted@example.com",
    "smtp_host": "smtp.gmail.com",
    "smtp_port": 587,
    "smtp_encryption": "tls",
    "smtp_local_domain": "company.com",
    "smtp_verify_peer": true,
    "legal_entity_id": 1234,
    "convert_rate_to_client": true,
    "e_invoicing_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    "enable_shop_api": true,
    "markdown_email_enabled": true,
    "use_comma_as_decimal_place": true,
    "settings": {
      "currency_id": "1",
      "timezone_id": "15",
      "date_format_id": "15",
      "military_time": true,
      "language_id": "1",
      "show_currency_code": true,
      "payment_terms": 1,
      "company_gateway_ids": "1,2,3,4",
      "custom_value1": "Custom Label",
      "custom_value2": "Custom Label",
      "custom_value3": "Custom Label",
      "custom_value4": "Custom Label",
      "default_task_rate": 10,
      "send_reminders": true,
      "enable_client_portal_tasks": true,
      "email_style": "light",
      "reply_to_email": "email@gmail.com",
      "bcc_email": "email@gmail.com, contact@gmail.com",
      "pdf_email_attachment": true,
      "ubl_email_attachment": true,
      "email_style_custom": "<HTML></HTML>",
      "counter_number_applied": "when_sent",
      "quote_number_applied": "when_sent",
      "custom_message_dashboard": "Please pay invoices immediately",
      "custom_message_unpaid_invoice": "Please pay invoices immediately",
      "custom_message_paid_invoice": "Thanks for paying this invoice!",
      "custom_message_unapproved_quote": "Please approve quote",
      "lock_invoices": "off",
      "auto_archive_invoice": true,
      "auto_archive_quote": true,
      "auto_convert_quote": true,
      "inclusive_taxes": true,
      "translations": {},
      "task_number_pattern": "{$year}-{$counter}",
      "task_number_counter": 1,
      "reminder_send_time": 32400,
      "expense_number_pattern": "{$year}-{$counter}",
      "expense_number_counter": 1,
      "vendor_number_pattern": "{$year}-{$counter}",
      "vendor_number_counter": 1,
      "ticket_number_pattern": "{$year}-{$counter}",
      "ticket_number_counter": 1,
      "payment_number_pattern": "{$year}-{$counter}",
      "payment_number_counter": 1,
      "invoice_number_pattern": "{$year}-{$counter}",
      "invoice_number_counter": 1,
      "quote_number_pattern": "{$year}-{$counter}",
      "quote_number_counter": 1,
      "client_number_pattern": "{$year}-{$counter}",
      "client_number_counter": 1,
      "credit_number_pattern": "{$year}-{$counter}",
      "credit_number_counter": 1,
      "recurring_invoice_number_prefix": "R",
      "reset_counter_frequency_id": 1,
      "reset_counter_date": "2019-01-01",
      "counter_padding": 1,
      "shared_invoice_quote_counter": true,
      "update_products": true,
      "convert_products": true,
      "fill_products": true,
      "invoice_terms": "Invoice Terms are...",
      "quote_terms": "Quote Terms are...",
      "invoice_taxes": 1,
      "invoice_design_id": "1",
      "quote_design_id": "1",
      "invoice_footer": "1",
      "invoice_labels": "1",
      "tax_rate1": 10,
      "tax_name1": "GST",
      "tax_rate2": 10,
      "tax_name2": "GST",
      "tax_rate3": 10,
      "tax_name3": "GST",
      "payment_type_id": "1",
      "custom_fields": "{}",
      "email_footer": "A default email footer",
      "email_sending_method": "default",
      "gmail_sending_user_id": "F76sd34D",
      "email_subject_invoice": "Your Invoice Subject",
      "email_subject_quote": "Your Quote Subject",
      "email_subject_payment": "Your Payment Subject",
      "email_template_invoice": "<HTML></HTML>",
      "email_template_quote": "<HTML></HTML>",
      "email_template_payment": "<HTML></HTML>",
      "email_subject_reminder1": "<HTML></HTML>",
      "email_subject_reminder2": "<HTML></HTML>",
      "email_subject_reminder3": "<HTML></HTML>",
      "email_subject_reminder_endless": "<HTML></HTML>",
      "email_template_reminder1": "<HTML></HTML>",
      "email_template_reminder2": "<HTML></HTML>",
      "email_template_reminder3": "<HTML></HTML>",
      "email_template_reminder_endless": "<HTML></HTML>",
      "enable_portal_password": true,
      "show_accept_invoice_terms": true,
      "show_accept_quote_terms": true,
      "require_invoice_signature": true,
      "require_quote_signature": true,
      "name": "Acme Co",
      "company_logo": "logo.png",
      "website": "https://www.acme.com",
      "address1": "Suite 888",
      "address2": "5 Jimbo Way",
      "city": "Sydney",
      "state": "Florida",
      "postal_code": "90210",
      "phone": "555-213-3948",
      "email": "joe@acme.co",
      "country_id": "1",
      "vat_number": "32 120 377 720",
      "page_size": "A4",
      "font_size": 9,
      "primary_font": "roboto",
      "secondary_font": "roboto",
      "email_template_statement": "template matter",
      "email_subject_statement": "subject matter",
      "quote_footer": "the quote footer",
      "email_subject_custom1": "Custom Subject 1",
      "email_subject_custom2": "Custom Subject 2",
      "email_subject_custom3": "Custom Subject 3",
      "email_template_custom1": "<HTML></HTML>",
      "email_template_custom2": "<HTML></HTML>",
      "email_template_custom3": "<HTML></HTML>",
      "num_days_reminder1": 9,
      "num_days_reminder2": 9,
      "num_days_reminder3": 9,
      "schedule_reminder1": "after_invoice_date",
      "schedule_reminder2": "after_invoice_date",
      "schedule_reminder3": "after_invoice_date",
      "late_fee_amount1": 10,
      "late_fee_amount2": 20,
      "late_fee_amount3": 100,
      "endless_reminder_frequency_id": "1",
      "default_expense_payment_type_id": "0",
      "e_invoice_type": "EN16931",
      "mailgun_endpoint": "api.mailgun.net",
      "client_initiated_payments_minimum": 10,
      "custom_sending_email": "bob@gmail.com",
      "company_logo_size": 100,
      "email_alignment": "left",
      "postmark_secret": "123456",
      "mailgun_secret": "123456",
      "mailgun_domain": "sandbox123456.mailgun.org",
      "besr_id": "123456",
      "qr_iban": "CH123456",
      "email_subject_purchase_order": "Purchase Order",
      "email_template_purchase_order": "Please see attached your purchase order.",
      "purchase_order_public_notes": "Please see attached your purchase order.",
      "purchase_order_terms": "Please see attached your purchase order.",
      "purchase_order_footer": "Please see attached your purchase order.",
      "purchase_order_design_id": "hd677df",
      "purchase_order_number_pattern": "PO-000000",
      "purchase_order_number_counter": 1,
      "page_numbering_alignment": "left",
      "email_from_name": "Bob Smith",
      "show_all_tasks_client_portal": "all",
      "entity_send_time": 9,
      "reply_to_name": "Bob Smith",
      "recurring_invoice_number_pattern": "R-000000",
      "recurring_invoice_number_counter": 1,
      "client_portal_under_payment_minimum": 10,
      "auto_bill_date": "on_send_date",
      "primary_color": "#ffffff",
      "secondary_color": "#ffffff",
      "auto_bill": "off",
      "client_portal_terms": "Please see attached your invoice.",
      "client_portal_privacy_policy": "These are the terms of use for using the client portal.",
      "portal_design_id": "hd677df",
      "late_fee_endless_percent": 10,
      "late_fee_endless_amount": 10,
      "email_signature": "Bob Smith",
      "classification": "individual",
      "valid_until": "30 days",
      "credit_terms": "Credit note terms",
      "credit_footer": "Credit note footer"
    }
  },
  "user": {
    "id": "Opnel5aKBz",
    "first_name": "Brad",
    "last_name": "Pitt",
    "email": "brad@pitt.com",
    "phone": "555-1233-23232",
    "signature": "Have a nice day!",
    "avatar": "https://url.to.your/avatar.png",
    "accepted_terms_version": "1.0.1",
    "oauth_user_id": "jkhasdf789as6f675sdf768sdfs",
    "oauth_provider_id": "google",
    "language_id": "1",
    "verified_phone_number": true,
    "sms_verification_code": "123456",
    "oauth_user_token_expiry": "2022-10-10",
    "has_password": true,
    "last_confirmed_email_address": "bob@gmail.com",
    "custom_value1": "Custom value 1",
    "custom_value2": "$1000",
    "custom_value3": "Custom value 3",
    "custom_value4": "Custom value 4",
    "is_deleted": true,
    "google_2fa_secret": "123456",
    "passkey_enabled": true,
    "passkey_count": 2,
    "oauth_user_refresh_token": "refresh_token_abc123",
    "shopify_user_id": "123456789",
    "user_logged_in_notification": true
  },
  "token": {
    "name": "Token Name",
    "token": "AS3df3jUUH765fhfd9KJuidj3JShjA",
    "is_system": true
  }
}

Changes

  • 69a36036d334Revision changes
    • info

      the response optional property / became read-only for the status

    • info

      the response optional property / became read-only for the status

  • 6e30c707b405Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status