--- title: "Create client" method: POST path: "/api/v1/clients" tags: ["clients"] --- # Create client `POST /api/v1/clients` ## Request - Base URL: `https://demo.invoiceninja.com` - URL: `https://demo.invoiceninja.com/api/v1/clients` - Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## POST /api/v1/clients Adds a client to a company > 🚨 Important When creating (or updating) a client you must include the child contacts with all mutating requests. Client contacts cannot be modified in isolation. ## Query parameters - `index` string - `include` string ## Headers - `X-API-TOKEN` string, required - `X-Requested-With` string, required ## Request body - ClientRequest - `id` string: The unique identifier of the client - `contacts` ClientContactRequest[], required: A list of contacts associated with 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 - `password` string: The hashed password of the contact - `send_email` boolean: Boolean flag that determines if 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. - `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 - `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, required: 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 client's shipping country expressed by the countries ISO number. Optionally, instead of the shipping_country_id you can pass either the iso_3166_2 or iso_3166_3 country code into the shipping_country_code property. - `is_deleted` boolean: A boolean value indicating whether the client has been deleted or not - `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 - `classification` string: The classification of the client - `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 ## Response `200` Returns the saved client object - 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 ## Other responses - `401`: Authentication error - `403`: Authorization error - `422`: Validation error - `429`: Rate Limit Exceeded - `default`: Unexpected Error ## Changes > 110 revisions in range; 1 not diffed. - **2026-04-20** `69a36036d334`: 4 info - added the new optional request property `contacts/items/can_sign` - added the new optional request property `contacts/items/cc_only` - added the optional property `contacts/items/can_sign` to the response with the `200` status - added the optional property `contacts/items/cc_only` to the response with the `200` status - **2025-11-22** `00ad5cc89fad`: 2 info - added the optional property `classification` to the response with the `200` status - added the optional property `public_notes` to the response with the `200` status - **2025-03-23** `a58163839754`: 1 info - added `subschema #1: Country Types` to the `country_id` request property `oneOf` list - **2025-03-23** `889dafb290e3`: 1 breaking - added `subschema #1: Country Types` to the `country_id` response property `oneOf` list for the response status `200` - **2024-11-17** `7cd7362d9d9f`: 1 info - added the new optional `query` request parameter `index` [Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/clients/post.md) --- [API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)