Mirrors/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-11 05:32:39 +01:00
Code Issues Releases Activity
6834ada604
invoiceninja/openapi/components/schemas/company_settings.yaml

592 lines
21 KiB
YAML
Raw Normal View History

Updates for openapi definitions
2023-03-19 00:39:21 +01:00
CompanySettings:
properties:
timezone_id:
description: 'The timezone id'
type: string
example: '15'
date_format_id:
description: 'The date format id'
type: string
example: '15'
military_time:
description: 'Toggles 12/24 hour time'
type: boolean
example: true
language_id:
description: 'The language id'
type: string
example: '1'
show_currency_code:
description: 'Toggles whether the currency symbol or code is shown'
type: boolean
example: true
currency_id:
description: 'The default currency id'
type: string
example: true
payment_terms:
description: '-1 sets no payment term, 0 sets payment due immediately, positive integers indicates payment terms in days'
type: integer
example: '1'
company_gateway_ids:
description: 'A commad separate list of available gateways'
type: string
example: '1,2,3,4'
custom_value1:
description: 'A Custom Label'
type: string
example: 'Custom Label'
custom_value2:
description: 'A Custom Label'
type: string
example: 'Custom Label'
custom_value3:
description: 'A Custom Label'
type: string
example: 'Custom Label'
custom_value4:
description: 'A Custom Label'
type: string
example: 'Custom Label'
default_task_rate:
description: 'The default task rate'
type: number
format: float
example: '10.00'
send_reminders:
description: 'Toggles whether reminders are sent'
type: boolean
example: true
enable_client_portal_tasks:
description: 'Show/hide the tasks panel in the client portal'
type: boolean
example: true
email_style:
description: 'options include plain,light,dark,custom'
type: string
example: light
reply_to_email:
description: 'The reply to email address'
type: string
example: email@gmail.com
bcc_email:
description: 'A comma separate list of BCC emails'
type: string
example: 'email@gmail.com, contact@gmail.com'
pdf_email_attachment:
description: 'Toggles whether to attach PDF as attachment'
type: boolean
example: true
ubl_email_attachment:
description: 'Toggles whether to attach UBL as attachment'
type: boolean
example: true
email_style_custom:
description: 'The custom template'
type: string
example: '<HTML></HTML>'
counter_number_applied:
description: 'enum when the invoice number counter is set, ie when_saved, when_sent, when_paid'
type: string
example: when_sent
quote_number_applied:
description: 'enum when the quote number counter is set, ie when_saved, when_sent'
type: string
example: when_sent
custom_message_dashboard:
description: 'A custom message which is displayed on the dashboard'
type: string
example: 'Please pay invoices immediately'
custom_message_unpaid_invoice:
description: 'A custom message which is displayed in the client portal when a client is viewing a unpaid invoice.'
type: string
example: 'Please pay invoices immediately'
custom_message_paid_invoice:
description: 'A custom message which is displayed in the client portal when a client is viewing a paid invoice.'
type: string
example: 'Thanks for paying this invoice!'
custom_message_unapproved_quote:
description: 'A custom message which is displayed in the client portal when a client is viewing a unapproved quote.'
type: string
example: 'Please approve quote'
lock_invoices:
description: 'Toggles whether invoices are locked once sent and cannot be modified further'
type: boolean
example: true
auto_archive_invoice:
description: 'Toggles whether a invoice is archived immediately following payment'
type: boolean
example: true
auto_archive_quote:
description: 'Toggles whether a quote is archived after being converted to a invoice'
type: boolean
example: true
auto_convert_quote:
description: 'Toggles whether a quote is converted to a invoice when approved'
type: boolean
example: true
inclusive_taxes:
description: 'Boolean flag determining whether inclusive or exclusive taxes are used'
type: boolean
example: true
translations:
description: 'JSON payload of customized translations'
type: object
example: ''
task_number_pattern:
description: 'Allows customisation of the task number pattern'
type: string
example: '{$year}-{$counter}'
task_number_counter:
description: 'The incrementing counter for tasks'
type: integer
example: '1'
reminder_send_time:
description: 'Time from UTC +0 when the email will be sent to the client'
type: integer
example: '32400'
expense_number_pattern:
description: 'Allows customisation of the expense number pattern'
type: string
example: '{$year}-{$counter}'
expense_number_counter:
description: 'The incrementing counter for expenses'
type: integer
example: '1'
vendor_number_pattern:
description: 'Allows customisation of the vendor number pattern'
type: string
example: '{$year}-{$counter}'
vendor_number_counter:
description: 'The incrementing counter for vendors'
type: integer
example: '1'
ticket_number_pattern:
description: 'Allows customisation of the ticket number pattern'
type: string
example: '{$year}-{$counter}'
ticket_number_counter:
description: 'The incrementing counter for tickets'
type: integer
example: '1'
payment_number_pattern:
description: 'Allows customisation of the payment number pattern'
type: string
example: '{$year}-{$counter}'
payment_number_counter:
description: 'The incrementing counter for payments'
type: integer
example: '1'
invoice_number_pattern:
description: 'Allows customisation of the invoice number pattern'
type: string
example: '{$year}-{$counter}'
invoice_number_counter:
description: 'The incrementing counter for invoices'
type: integer
example: '1'
quote_number_pattern:
description: 'Allows customisation of the quote number pattern'
type: string
example: '{$year}-{$counter}'
quote_number_counter:
description: 'The incrementing counter for quotes'
type: integer
example: '1'
client_number_pattern:
description: 'Allows customisation of the client number pattern'
type: string
example: '{$year}-{$counter}'
client_number_counter:
description: 'The incrementing counter for clients'
type: integer
example: '1'
credit_number_pattern:
description: 'Allows customisation of the credit number pattern'
type: string
example: '{$year}-{$counter}'
credit_number_counter:
description: 'The incrementing counter for credits'
type: integer
example: '1'
recurring_invoice_number_prefix:
description: 'This string is prepended to the recurring invoice number'
type: string
example: R
reset_counter_frequency_id:
description: 'CONSTANT which is used to apply the frequency which the counters are reset'
type: integer
example: '1'
reset_counter_date:
description: 'The explicit date which is used to reset counters'
type: string
example: '2019-01-01'
counter_padding:
description: 'Pads the counter with leading zeros'
type: integer
example: '1'
shared_invoice_quote_counter:
description: 'Flags whether to share the counter for invoices and quotes'
type: boolean
example: true
update_products:
description: 'Determines if client fields are updated from third party APIs'
type: boolean
example: true
convert_products:
description: ''
type: boolean
example: true
fill_products:
description: 'Automatically fill products based on product_key'
type: boolean
example: true
invoice_terms:
description: 'The default invoice terms'
type: string
example: 'Invoice Terms are...'
quote_terms:
description: 'The default quote terms'
type: string
example: 'Quote Terms are...'
invoice_taxes:
description: 'Taxes can be applied to the invoice'
type: number
example: '1'
invoice_design_id:
description: 'The default design id (invoice, quote etc)'
type: string
example: '1'
quote_design_id:
description: 'The default design id (invoice, quote etc)'
type: string
example: '1'
invoice_footer:
description: 'The default invoice footer'
type: string
example: '1'
invoice_labels:
description: 'JSON string of invoice labels'
type: string
example: '1'
tax_rate1:
description: 'The tax rate (float)'
type: number
example: '10'
tax_name1:
description: 'The tax name'
type: string
example: GST
tax_rate2:
description: 'The tax rate (float)'
type: number
example: '10'
tax_name2:
description: 'The tax name'
type: string
example: GST
tax_rate3:
description: 'The tax rate (float)'
type: number
example: '10'
tax_name3:
description: 'The tax name'
type: string
example: GST
payment_type_id:
description: 'The default payment type id'
type: string
example: '1'
custom_fields:
description: 'JSON string of custom fields'
type: string
example: '{}'
email_footer:
description: 'The default email footer'
type: string
example: 'A default email footer'
email_sending_method:
description: 'The email driver to use to send email, options include default, gmail'
type: string
example: default
gmail_sending_user_id:
description: 'The hashed_id of the user account to send email from'
type: string
example: F76sd34D
email_subject_invoice:
description: ''
type: string
example: 'Your Invoice Subject'
email_subject_quote:
description: ''
type: string
example: 'Your Quote Subject'
email_subject_payment:
description: ''
type: string
example: 'Your Payment Subject'
email_template_invoice:
description: 'The full template for invoice emails'
type: string
example: '<HTML></HTML>'
email_template_quote:
description: 'The full template for quote emails'
type: string
example: '<HTML></HTML>'
email_template_payment:
description: 'The full template for payment emails'
type: string
example: '<HTML></HTML>'
email_subject_reminder1:
description: 'Email subject for Reminder'
type: string
example: '<HTML></HTML>'
email_subject_reminder2:
description: 'Email subject for Reminder'
type: string
example: '<HTML></HTML>'
email_subject_reminder3:
description: 'Email subject for Reminder'
type: string
example: '<HTML></HTML>'
email_subject_reminder_endless:
description: 'Email subject for endless reminders'
type: string
example: '<HTML></HTML>'
email_template_reminder1:
description: 'The full template for Reminder 1'
type: string
example: '<HTML></HTML>'
email_template_reminder2:
description: 'The full template for Reminder 2'
type: string
example: '<HTML></HTML>'
email_template_reminder3:
description: 'The full template for Reminder 3'
type: string
example: '<HTML></HTML>'
email_template_reminder_endless:
description: 'The full template for enless reminders'
type: string
example: '<HTML></HTML>'
enable_portal_password:
description: 'Toggles whether a password is required to log into the client portal'
type: boolean
example: true
show_accept_invoice_terms:
description: 'Toggles whether the terms dialogue is shown to the client'
type: boolean
example: true
show_accept_quote_terms:
description: 'Toggles whether the terms dialogue is shown to the client'
type: boolean
example: true
require_invoice_signature:
description: 'Toggles whether a invoice signature is required'
type: boolean
example: true
require_quote_signature:
description: 'Toggles whether a quote signature is required'
type: boolean
example: true
name:
description: 'The company name'
type: string
example: 'Acme Co'
company_logo:
description: 'The company logo file'
type: object
example: logo.png
website:
description: 'The company website URL'
type: string
example: www.acme.com
address1:
description: 'The company address line 1'
type: string
example: 'Suite 888'
address2:
description: 'The company address line 2'
type: string
example: '5 Jimbo Way'
city:
description: 'The company city'
type: string
example: Sydney
state:
description: 'The company state'
type: string
example: Florisa
postal_code:
description: 'The company zip/postal code'
type: string
example: '90210'
phone:
description: 'The company phone'
type: string
example: 555-213-3948
email:
description: 'The company email'
type: string
example: joe@acme.co
country_id:
description: 'The country ID'
type: string
example: '1'
vat_number:
description: 'The company VAT/TAX ID number'
type: string
example: '32 120 377 720'
page_size:
description: 'The default page size'
type: string
example: A4
font_size:
description: 'The font size'
type: number
example: '9'
primary_font:
description: 'The primary font'
type: string
example: roboto
secondary_font:
description: 'The secondary font'
type: string
example: roboto
hide_paid_to_date:
description: 'Flags whether to hide the paid to date field'
type: boolean
example: false
embed_documents:
description: 'Toggled whether to embed documents in the PDF'
type: boolean
example: false
all_pages_header:
description: 'The header for the PDF'
type: boolean
example: false
all_pages_footer:
description: 'The footer for the PDF'
type: boolean
example: false
document_email_attachment:
description: 'Toggles whether to attach documents in the email'
type: boolean
example: false
enable_client_portal_password:
description: 'Toggles password protection of the client portal'
type: boolean
example: false
enable_email_markup:
description: 'Toggles the use of markdown in emails'
type: boolean
example: false
enable_client_portal_dashboard:
description: 'Toggles whether the client dashboard is shown in the client portal'
type: boolean
example: false
enable_client_portal:
description: 'Toggles whether the entire client portal is displayed to the client, or only the context'
type: boolean
example: false
email_template_statement:
description: 'The body of the email for statements'
type: string
example: 'template matter'
email_subject_statement:
description: 'The subject of the email for statements'
type: string
example: 'subject matter'
signature_on_pdf:
description: 'Toggles whether the signature (if available) is displayed on the PDF'
type: boolean
example: false
quote_footer:
description: 'The default quote footer'
type: string
example: 'the quote footer'
email_subject_custom1:
description: 'Custom reminder template subject'
type: string
example: 'Custom Subject 1'
email_subject_custom2:
description: 'Custom reminder template subject'
type: string
example: 'Custom Subject 2'
email_subject_custom3:
description: 'Custom reminder template subject'
type: string
example: 'Custom Subject 3'
email_template_custom1:
description: 'Custom reminder template body'
type: string
example: '<HTML>'
email_template_custom2:
description: 'Custom reminder template body'
type: string
example: '<HTML>'
email_template_custom3:
description: 'Custom reminder template body'
type: string
example: '<HTML>'
enable_reminder1:
description: 'Toggles whether this reminder is enabled'
type: boolean
example: false
enable_reminder2:
description: 'Toggles whether this reminder is enabled'
type: boolean
example: false
enable_reminder3:
description: 'Toggles whether this reminder is enabled'
type: boolean
example: false
num_days_reminder1:
description: 'The Reminder interval'
type: number
example: '9'
num_days_reminder2:
description: 'The Reminder interval'
type: number
example: '9'
num_days_reminder3:
description: 'The Reminder interval'
type: number
example: '9'
schedule_reminder1:
description: '(enum: after_invoice_date, before_due_date, after_due_date)'
type: string
example: after_invoice_date
schedule_reminder2:
description: '(enum: after_invoice_date, before_due_date, after_due_date)'
type: string
example: after_invoice_date
schedule_reminder3:
description: '(enum: after_invoice_date, before_due_date, after_due_date)'
type: string
example: after_invoice_date
late_fee_amount1:
description: 'The late fee amount for reminder 1'
type: number
example: 10
late_fee_amount2:
description: 'The late fee amount for reminder 2'
type: number
example: 20
late_fee_amount3:
description: 'The late fee amount for reminder 2'
type: number
example: 100
endless_reminder_frequency_id:
description: 'The frequency id of the endless reminder'
type: string
example: '1'
client_online_payment_notification:
description: 'Determines if a client should receive the notification for a online payment'
type: boolean
example: false
client_manual_payment_notification:
description: 'Determines if a client should receive the notification for a manually entered payment'
type: boolean
example: false
type: object
Copy Permalink