activities
Returns a list of activities
Changed onLists all activities related to this company
get/api/v1/activities
Request
- Base URLhttps://demo.invoiceninja.com
- Authnone declared. Required headers: X-API-TOKEN, X-Requested-With
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
includestring
Include child relations of the Activity object, format is comma separated. Note it is possible to chain multiple includes together, ie. include=account,token
indexstring
Example:user
Replaces the default response index from data to a user specific string
ie.
?index=new_index
response is wrapped
{
'new_index' : [
.....
]
}
per_pageinteger
Example:20
The number of records to return for each request, default is 20
pageinteger
Example:1
The page number to return for this request (when performing pagination), default is 1
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
Returns the list of activities
Example response
{
"data": [
{
"id": "Opnel5aKBz",
"activity_type_id": "Opnel5aKBz",
"client_id": "Opnel5aKBz",
"company_id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"invoice_id": "Opnel5aKBz",
"payment_id": "Opnel5aKBz",
"credit_id": "Opnel5aKBz",
"updated_at": 343421434,
"expense_id": "Opnel5aKBz",
"is_system": true,
"contact_id": "Opnel5aKBz",
"task_id": "Opnel5aKBz",
"notes": "Opnel5aKBz",
"token_id": "Opnel5aKBz",
"ip": "192.168.1.252",
"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,
"company_user": {
"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
}
}
},
"client": {
"id": "Opnel5aKBz",
"contacts": [
{
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"client_id": "Opnel5aKBz",
"first_name": "John",
"last_name": "Doe",
"phone": "555-152-4524",
"accepted_terms_version": "A long set of ToS",
"password": "*****",
"confirmation_code": "333-sdjkh34gbasd",
"token": "333-sdjkh34gbasd",
"contact_key": "JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a",
"is_primary": true,
"confirmed": true,
"is_locked": true,
"send_email": true,
"failed_logins": 3,
"email_verified_at": 134341234234,
"last_login": 134341234234,
"created_at": 134341234234,
"updated_at": 134341234234,
"deleted_at": 134341234234
}
],
"user_id": "Ua6Rw4pVbS",
"assigned_user_id": "Ua6Rw4pVbS",
"name": "Jim's Housekeeping",
"website": "https://www.jims-housekeeping.com",
"private_notes": "Client prefers email communication over phone calls",
"client_hash": "asdfkjhk342hjhbfdvmnfb1",
"industry_id": 5,
"size_id": 2,
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "Beverly Hills",
"state": "California",
"postal_code": "90210",
"phone": "555-3434-3434",
"custom_value1": "Preferred contact: Email",
"custom_value2": "Account manager: John Doe",
"custom_value3": "VIP client: Yes",
"custom_value4": "Annual contract value: $50,000",
"vat_number": "VAT123456",
"number": "CL-0001",
"shipping_address1": "5 Wallaby Way",
"shipping_address2": "Suite 5",
"shipping_city": "Perth",
"shipping_state": "Western Australia",
"shipping_postal_code": "6110",
"shipping_country_id": 4,
"balance": 500,
"paid_to_date": 2000,
"credit_balance": 100,
"last_login": 1628686031,
"created_at": 1617629031,
"updated_at": 1628445631,
"group_settings_id": "Opnel5aKBz",
"routing_id": "Opnel5aKBz3489-dfkiu-2239-sdsd",
"payment_balance": 100,
"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": true,
"auto_archive_invoice": true,
"auto_archive_quote": true,
"auto_convert_quote": true,
"inclusive_taxes": true,
"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": {},
"website": "https://www.acme.com",
"address1": "Suite 888",
"address2": "5 Jimbo Way",
"city": "Sydney",
"state": "Florisa",
"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>",
"email_template_custom2": "<HTML>",
"email_template_custom3": "<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 or api.eu.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",
"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": "VIP",
"public_notes": "These are public notes visible to clients"
},
"contact": {
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"client_id": "Opnel5aKBz",
"first_name": "John",
"last_name": "Doe",
"phone": "555-152-4524",
"accepted_terms_version": "A long set of ToS",
"password": "*****",
"confirmation_code": "333-sdjkh34gbasd",
"token": "333-sdjkh34gbasd",
"contact_key": "JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a",
"is_primary": true,
"confirmed": true,
"is_locked": true,
"send_email": true,
"failed_logins": 3,
"email_verified_at": 134341234234,
"last_login": 134341234234,
"created_at": 134341234234,
"updated_at": 134341234234,
"deleted_at": 134341234234
},
"recurring_invoice": {
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"assigned_user_id": "Opnel5aKBz",
"client_id": "Opnel5aKBz",
"status_id": "4",
"frequency_id": 4,
"remaining_cycles": 4,
"number": "INV_101",
"po_number": "PO-1234",
"terms": "These are invoice terms",
"public_notes": "These are some public notes",
"private_notes": "These are some private notes",
"custom_value1": "2022-10-01",
"custom_value2": "Something custom",
"tax_rate1": 10,
"tax_rate2": 10,
"tax_rate3": 10,
"total_taxes": 10,
"line_items": {},
"amount": 10,
"balance": 10,
"paid_to_date": 10,
"discount": 10,
"partial": 10,
"is_amount_discount": true,
"is_deleted": true,
"uses_inclusive_taxes": true,
"date": "1994-07-30",
"last_sent_date": "1994-07-30",
"next_send_date": "1994-07-30",
"partial_due_date": "1994-07-30",
"due_date": "1994-07-30",
"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"
},
"last_viewed": 1434342123,
"updated_at": 1434342123,
"archived_at": 1434342123,
"custom_surcharge1": 10,
"custom_surcharge2": 10,
"custom_surcharge3": 10,
"custom_surcharge4": 10,
"custom_surcharge_tax1": true,
"custom_surcharge_tax2": true,
"custom_surcharge_tax3": true,
"custom_surcharge_tax4": true,
"location_id": "Opnel5aKBz",
"auto_bill": "always",
"auto_bill_enabled": true,
"design_id": "Opnel5aKBz",
"due_date_days": 30,
"exchange_rate": 1,
"next_send_date_client": "2024-12-31",
"project_id": "Opnel5aKBz",
"vendor_id": "Opnel5aKBz"
},
"invoice": {
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"assigned_user_id": "Opnel5aKBz",
"client_id": "Opnel5aKBz",
"status_id": "4",
"number": "INV_101",
"po_number": "PO-1234",
"terms": "These are invoice terms",
"public_notes": "These are some public notes",
"private_notes": "These are some private notes",
"custom_value1": "2022-10-01",
"custom_value2": "Something custom",
"tax_rate1": 10,
"tax_rate2": 10,
"tax_rate3": 10,
"total_taxes": 10,
"line_items": [
{
"quantity": 1,
"cost": 10,
"product_key": "Product key",
"tags": "Retail,Priority Customer",
"product_cost": 10,
"notes": "Item notes",
"discount": 5,
"tax_name1": "GST",
"tax_rate1": 10,
"tax_name2": "VAT",
"tax_rate2": 5,
"tax_name3": "CA Sales Tax",
"tax_rate3": 3,
"sort_id": "0",
"line_total": 10,
"gross_line_total": 15,
"tax_amount": 1,
"custom_value1": "Custom value 1",
"custom_value2": "Custom value 2",
"custom_value3": "Custom value 3",
"custom_value4": "Custom value 4",
"type_id": "1",
"tax_id": "1"
}
],
"invitations": [
{
"id": "Opnel5aKBz",
"client_contact_id": "Opnel5aKBz",
"key": "Opnel5aKBz4343343566236gvbb",
"link": "https://www.example.com/invitations/Opnel5aKBz4343343566236gvbb",
"updated_at": 1434342123,
"archived_at": 1434342123,
"email_error": "The email error"
}
],
"amount": 10,
"balance": 10,
"paid_to_date": 10,
"discount": 10,
"partial": 10,
"is_amount_discount": true,
"is_deleted": true,
"uses_inclusive_taxes": true,
"date": "1994-07-30",
"last_sent_date": "1994-07-30",
"next_send_date": "1994-07-30",
"partial_due_date": "1994-07-30",
"due_date": "1994-07-30",
"last_viewed": 1434342123,
"updated_at": 1434342123,
"archived_at": 1434342123,
"custom_surcharge1": 10,
"custom_surcharge2": 10,
"custom_surcharge3": 10,
"custom_surcharge4": 10,
"custom_surcharge_tax1": true,
"custom_surcharge_tax2": true,
"custom_surcharge_tax3": true,
"custom_surcharge_tax4": true,
"project_id": "Opnel5aKBz",
"auto_bill_tries": 1,
"auto_bill_enabled": true,
"subscription_id": "Opnel5aKBz",
"location_id": "Opnel5aKBz",
"design_id": "Opnel5aKBz",
"exchange_rate": 1,
"vendor_id": "Opnel5aKBz"
},
"credit": {
"id": "Opnel5aKBz",
"user_id": "1a2b3c4d5e",
"assigned_user_id": "6f7g8h9i0j",
"client_id": "p1q2r3s4t5",
"status_id": "3",
"invoice_id": "u1v2w3x4y5",
"number": "QUOTE_101",
"po_number": "PO_12345",
"terms": "Net 30",
"public_notes": "Thank you for your business.",
"private_notes": "Client is requesting a discount.",
"footer": "Footer text goes here.",
"custom_value1": "Custom data 1",
"custom_value2": "Custom data 2",
"custom_value3": "Custom data 3",
"custom_value4": "Custom data 4",
"tax_name1": "VAT",
"tax_name2": "GST",
"tax_rate1": 10,
"tax_rate2": 5,
"tax_name3": "PST",
"tax_rate3": 8,
"total_taxes": 23,
"line_items": [
{
"quantity": 1,
"cost": 10,
"product_key": "Product key",
"tags": "Retail,Priority Customer",
"product_cost": 10,
"notes": "Item notes",
"discount": 5,
"tax_name1": "GST",
"tax_rate1": 10,
"tax_name2": "VAT",
"tax_rate2": 5,
"tax_name3": "CA Sales Tax",
"tax_rate3": 3,
"sort_id": "0",
"line_total": 10,
"gross_line_total": 15,
"tax_amount": 1,
"custom_value1": "Custom value 1",
"custom_value2": "Custom value 2",
"custom_value3": "Custom value 3",
"custom_value4": "Custom value 4",
"type_id": "1",
"tax_id": "1"
}
],
"invitations": [
{
"id": "Opnel5aKBz",
"client_contact_id": "Opnel5aKBz",
"key": "Opnel5aKBz4343343566236gvbb",
"link": "https://www.example.com/invitations/Opnel5aKBz4343343566236gvbb",
"updated_at": 1434342123,
"archived_at": 1434342123,
"email_error": "The email error"
}
],
"amount": 100,
"balance": 50,
"paid_to_date": 50,
"discount": 10,
"partial": 20,
"is_amount_discount": true,
"uses_inclusive_taxes": true,
"date": "1994-07-30",
"last_sent_date": "1994-07-30",
"next_send_date": "1994-07-30",
"partial_due_date": "1994-07-30",
"due_date": "1994-07-30",
"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"
},
"last_viewed": 1434342123,
"updated_at": 1434342123,
"archived_at": 1434342123,
"custom_surcharge1": 10,
"custom_surcharge2": 10,
"custom_surcharge3": 10,
"custom_surcharge4": 10,
"custom_surcharge_tax1": true,
"custom_surcharge_tax2": true,
"custom_surcharge_tax3": true,
"custom_surcharge_tax4": true,
"location_id": "Opnel5aKBz",
"design_id": "Opnel5aKBz",
"exchange_rate": 1,
"project_id": "Opnel5aKBz",
"subscription_id": "Opnel5aKBz",
"vendor_id": "Opnel5aKBz"
},
"quote": {
"id": "Opnel5aKBz",
"number": "QUOTE_101",
"po_number": "PO-1234",
"terms": "These are some quote terms. Valid for 14 days.",
"public_notes": "These are public notes which the client may see",
"private_notes": "These are private notes, not to be disclosed to the client",
"footer": "The text goes in the footer of the quote",
"custom_value1": "A custom value",
"custom_value2": "A custom value",
"custom_value3": "A custom value",
"custom_value4": "A custom value",
"tax_name1": "GST",
"tax_name2": "VAT",
"tax_rate1": 10,
"tax_rate2": 10,
"tax_rate3": 10,
"total_taxes": 10,
"line_items": [
{
"quantity": 1,
"cost": 10,
"product_key": "Product key",
"tags": "Retail,Priority Customer",
"product_cost": 10,
"notes": "Item notes",
"discount": 5,
"tax_name1": "GST",
"tax_rate1": 10,
"tax_name2": "VAT",
"tax_rate2": 5,
"tax_name3": "CA Sales Tax",
"tax_rate3": 3,
"sort_id": "0",
"line_total": 10,
"gross_line_total": 15,
"tax_amount": 1,
"custom_value1": "Custom value 1",
"custom_value2": "Custom value 2",
"custom_value3": "Custom value 3",
"custom_value4": "Custom value 4",
"type_id": "1",
"tax_id": "1"
}
],
"amount": 10,
"balance": 10,
"paid_to_date": 10,
"discount": 10,
"partial": 10,
"is_amount_discount": true,
"uses_inclusive_taxes": true,
"date": "1994-07-30",
"last_sent_date": "1994-07-30",
"next_send_date": "1994-07-30",
"partial_due_date": "1994-07-30",
"due_date": "1994-07-30",
"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"
},
"last_viewed": 1434342123,
"updated_at": 1434342123,
"archived_at": 1434342123,
"custom_surcharge1": 10,
"custom_surcharge2": 10,
"custom_surcharge3": 10,
"custom_surcharge4": 10,
"custom_surcharge_tax1": true,
"custom_surcharge_tax2": true,
"custom_surcharge_tax3": true,
"custom_surcharge_tax4": true,
"location_id": "Opnel5aKBz",
"design_id": "Opnel5aKBz",
"exchange_rate": 1,
"project_id": "Opnel5aKBz",
"subscription_id": "Opnel5aKBz",
"vendor_id": "Opnel5aKBz"
},
"payment": {
"id": "Opnel5aKBz",
"client_id": "Opnel5aKBz",
"invitation_id": "Opnel5aKBz",
"client_contact_id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"type_id": "1",
"date": "1-1-2014",
"transaction_reference": "xcsSxcs124asd",
"assigned_user_id": "Opnel5aKBz",
"private_notes": "The payment was refunded due to error",
"is_manual": true,
"is_deleted": true,
"amount": 10,
"refunded": 10,
"updated_at": 1434342123,
"archived_at": 1434342123,
"company_gateway_id": "3",
"paymentables": {
"id": "AS3df3A",
"invoice_id": "AS3df3A",
"credit_id": "AS3df3A",
"refunded": 10,
"amount": 10,
"updated_at": 1434342123,
"created_at": 1434342123
},
"invoices": [
{
"invoice_id": "Opnel5aKBz",
"amount": "2"
}
],
"credits": [
{
"credit_id": "Opnel5aKBz",
"amount": "2"
}
],
"number": "PAY_101",
"category_id": "Opnel5aKBz",
"custom_value1": "Payment reference 123",
"custom_value2": "Approved by John",
"custom_value3": "Urgent payment",
"custom_value4": "Q1 2024",
"exchange_currency_id": "2",
"exchange_rate": 1,
"idempotency_key": "key_1234567890abcdef"
},
"expense": {
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"assigned_user_id": "Opnel5aKBz",
"project_id": "Opnel5aKBz",
"client_id": "Opnel5aKBz",
"invoice_id": "Opnel5aKBz",
"invoice_currency_id": "1",
"currency_id": "2",
"invoice_category_id": "Opnel5aKBz",
"recurring_expense_id": "Opnel5aKBz",
"tax_amount": 10,
"tax_name1": "GST",
"tax_name2": "VAT",
"tax_name3": "IVA",
"tax_rate1": 10,
"tax_rate2": 10,
"tax_rate3": 10,
"amount": 10,
"foreign_amount": 10,
"exchange_rate": 0.8,
"date": "2022-12-01",
"payment_date": "2022-12-01",
"should_be_invoiced": true,
"is_deleted": true,
"invoice_documents": true,
"updated_at": 1434342123,
"archived_at": 1434342123,
"calculate_tax_by_amount": true,
"category_id": "Opnel5aKBz",
"number": "EXP-0001",
"purchase_order_id": "Opnel5aKBz",
"tax_amount1": 10,
"tax_amount2": 5,
"tax_amount3": 2.5,
"transaction_id": "txn_1234567890",
"uses_inclusive_taxes": true,
"vendor_id": "Opnel5aKBz"
},
"task": {
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"assigned_user_id": "Opnel5aKBz",
"client_id": "Opnel5aKBz",
"invoice_id": "Opnel5aKBz",
"project_id": "Opnel5aKBz",
"number": "TASK-123",
"time_log": "[[1,2],[3,4]]",
"is_running": true,
"is_deleted": true,
"task_status_id": "Opnel5aKBz",
"description": "A wonder task to work on",
"duration": 3600,
"task_status_order": 4,
"rate": 10,
"custom_value1": "2022-10-10",
"custom_value2": "$1100",
"custom_value3": "I need help",
"custom_value4": "INV-3343",
"is_date_based": true,
"calculated_start_date": "2022-10-10",
"invoice_documents": true,
"created_at": 1434342123,
"updated_at": 1434342123,
"archived_at": 1434342123,
"hash": "a1b2c3d4e5f6",
"status_id": "Opnel5aKBz",
"status_order": 1,
"status_sort_order": 1,
"tags": [
{
"id": "Opnel5aKBz",
"name": "Urgent",
"color": "#FF0000"
}
]
},
"purchase_order": {
"id": "Opnel5aKBz",
"number": "PO_101",
"quote_number": "QUOTE_101",
"terms": "These are some purchase order terms. Valid for 14 days.",
"public_notes": "These are public notes which the vendor may see",
"private_notes": "These are private notes, not to be disclosed to the vendor",
"footer": "The text goes in the footer of the purchase order",
"custom_value1": "A custom value",
"custom_value2": "A custom value",
"custom_value3": "A custom value",
"custom_value4": "A custom value",
"tax_name1": "GST",
"tax_name2": "VAT",
"tax_rate1": 10,
"tax_rate2": 10,
"tax_rate3": 10,
"total_taxes": 10,
"line_items": [
{
"quantity": 1,
"cost": 10,
"product_key": "Product key",
"tags": "Retail,Priority Customer",
"product_cost": 10,
"notes": "Item notes",
"discount": 5,
"tax_name1": "GST",
"tax_rate1": 10,
"tax_name2": "VAT",
"tax_rate2": 5,
"tax_name3": "CA Sales Tax",
"tax_rate3": 3,
"sort_id": "0",
"line_total": 10,
"gross_line_total": 15,
"tax_amount": 1,
"custom_value1": "Custom value 1",
"custom_value2": "Custom value 2",
"custom_value3": "Custom value 3",
"custom_value4": "Custom value 4",
"type_id": "1",
"tax_id": "1"
}
],
"amount": 10,
"balance": 10,
"paid_to_date": 10,
"discount": 10,
"partial": 10,
"is_amount_discount": true,
"uses_inclusive_taxes": true,
"date": "1994-07-30",
"last_sent_date": "1994-07-30",
"next_send_date": "1994-07-30",
"partial_due_date": "1994-07-30",
"due_date": "1994-07-30",
"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"
},
"last_viewed": 1434342123,
"updated_at": 1434342123,
"archived_at": 1434342123,
"custom_surcharge1": 10,
"custom_surcharge2": 10,
"custom_surcharge3": 10,
"custom_surcharge4": 10,
"custom_surcharge_tax1": true,
"custom_surcharge_tax2": true,
"custom_surcharge_tax3": true,
"custom_surcharge_tax4": true,
"backup": "backup_data.json",
"client_id": "Opnel5aKBz",
"currency_id": "1",
"design_id": "Opnel5aKBz",
"exchange_rate": 1,
"invoice_id": "Opnel5aKBz",
"quote_id": "Opnel5aKBz",
"location_id": "Opnel5aKBz",
"po_number": "PO-2024-001",
"project_id": "Opnel5aKBz",
"recurring_id": "Opnel5aKBz",
"reminder1_sent": 1234567890,
"reminder2_sent": 1234567890,
"reminder3_sent": 1234567890,
"reminder_last_sent": 1234567890
},
"vendor": {
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"assigned_user_id": "Opnel5aKBz",
"contacts": [
{
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"vendor_id": "Opnel5aKBz",
"first_name": "Harry",
"last_name": "Windsor",
"contact_key": "JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a",
"confirmation_code": "333-sdjkh34gbasd",
"phone": "555-123-1234",
"custom_value1": "2022-10-10",
"custom_value2": "$1000",
"email": "harry@windsor.com",
"email_verified_at": 134341234234,
"password": "*****",
"is_primary": true,
"created_at": 134341234234,
"updated_at": 134341234234,
"deleted_at": 134341234234,
"send_email": true
}
],
"name": "Harry cafe de wheels",
"classification": "individual",
"website": "www.harry.com",
"private_notes": "Shhh, do not tell the vendor",
"industry_id": "1",
"phone": "555-3434-3434",
"currency_id": "4",
"number": "11234",
"is_deleted": true,
"language_id": "1",
"vendor_hash": "aaa-sss-www",
"transaction_name": "aaa-sss-www",
"last_login": 134341234234,
"created_at": 134341234234,
"updated_at": 134341234234,
"display_name": "Bob the vendor",
"public_notes": "These are public notes visible to vendors",
"routing_id": "0088:12345678901"
},
"vendor_contact": {
"id": "Opnel5aKBz",
"user_id": "Opnel5aKBz",
"vendor_id": "Opnel5aKBz",
"first_name": "Harry",
"last_name": "Windsor",
"contact_key": "JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a",
"confirmation_code": "333-sdjkh34gbasd",
"phone": "555-123-1234",
"custom_value1": "2022-10-10",
"custom_value2": "$1000",
"email": "harry@windsor.com",
"email_verified_at": 134341234234,
"password": "*****",
"is_primary": true,
"created_at": 134341234234,
"updated_at": 134341234234,
"deleted_at": 134341234234,
"send_email": true
}
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 1,
"current_page": 1,
"total_pages": 1
}
}
}Changes
- info
added the optional property
///to the response with the status
- info
- info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status
- info