Update invoice by ID

Update an invoice

PUT /invoices/{invoiceId}

Update invoice by ID

cURL

curl --request PUT \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/invoices/{invoiceId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "tax_rate": "0.00",
  "title": "some string"
}
'

200

{
  "error": false,
  "response": {}
}

Body raw (json)

{
    "customer_id"// optional | nullable | integer | required if job_id is not set and is_template is not set or false | existing customer id
    "job_id"// optional | nullable | integer | required if is_template is not set or false | existing job id
    "status"// optional | integer | acceptable_values: 2(draft),3(invoiced),4(paid),5(partialy paid),6(void)
    "status_id"// optional | integer | existing invoice type custom status id
    "status_workflow_id"// optional | integer | existing invoice type status workflow id
    "notes"// optional | string | max:4000
    "invoiced_date"// optional | nullable | timestamp
    "due_date"// optional | nullable | timestamp
    "tax_rate"// required | string | numeric | example: "0.00"
    "is_template"// optional | boolean | Description: if true, the invoice will be template
    "title"// optional | string | max:255
    "author_id"// optional | nullable | integer | existing user id
    "location_id"// optional | nullable | integer | existing location id
    "contract_id"// optional | nullable | integer | existing contract id
    "commission_type"// optional | integer | between:0,3
    "commission_percent"// optional | integer | between:0,100
    "invoice_use_logo"// optional | nullable | boolean
    "invoice_show_line_item_unit_price"// optional | nullable | boolean
    "invoice_show_line_item_qty"// optional | nullable | boolean
    "invoice_show_line_item_taxed"// optional | nullable | boolean
    "invoice_show_line_item_total"// optional | nullable | boolean
    "invoice_show_line_item_desc"// optional | nullable | boolean
    "invoice_show_line_item_sku"// optional | nullable | boolean
    "invoice_show_total_tax"// optional | nullable | boolean
    "invoice_show_job_title"// optional | nullable | boolean
    "invoice_show_job_location"// optional | nullable | boolean
    "invoice_show_assigned_members"// optional | nullable | boolean
    "invoice_show_author"// optional | nullable | boolean
    "invoice_show_service_address"// optional | nullable | boolean
    "invoice_contract_signature_lines"// optional | integer | between:0,2
    "invoice_amount_due_display_type"// optional | string | acceptable_values: remaining_balance,set_amount,percentage_of_total,none
    "invoice_amount_due_display_value"// optional | string
    "invoice_pdf_title"// optional | string | max:100
    "estimate_status"// optional | integer
    "theme_id"// optional | nullable | integer | existing theme id
    "internal_notes"// optional | nullable | string
    "reference"// optional | nullable | string
    "hvi"// optional | numeric
    "company_profile_id"// optional | nullable | integer | existing alternate company profile id
    "maintenance_agreement_id"// optional | nullable | integer | existing maintenance agreement id
    "maintenance_occurrence_id"// optional | nullable | integer | existing maintenance occurrence id
    "occurrence_date"// optional | nullable | required when maintenance agreement id is set and maintenance occurrence id is empty
    "qbd_class_id" // optional | nullable | integer | existing Quickbook Class id
    "qbd_discount_id" // optional | nullable | integer | existing Quickbook Discount Item id
    "qbo_sales_tax_code_id" //  optional | nullable | integer | existing Quickbook Tax Code id
    "display_settings": {// optional | nullable | object
        "show_payment_button"// required | boolean
        "show_signature_button"// required | boolean
        "show_company_title"// optional | boolean
        "is_customer_phone_visible"// optional | boolean
        "is_modified_customer"// optional | boolean
        "modified_customer_display_name"// optional | string
        "modified_customer_display_address"// optional | string
    }
    "estimate_display_settings": {// optional | nullable | object
        "show_payment_button"// required | boolean
        "show_company_title"// optional | boolean
        "is_customer_phone_visible"// optional | boolean
    }
    "expenses": [// optional | nullable | array of objects
        {
            "amount"// required | string | numeric
            "description"// optional | string | max:1000
            "title"// required | string | min:3 | max:60
            "type"// required | string | acceptable_values: service,product
        }
    ]
    "options": [// optional | nullable | array of objects
        {
            "is_selected"// required | boolean
            "is_default"// required | boolean
            "group_number"// required | integer
            "title"// optional | nullable | string
            "description"// optional | nullable | string
            "photo_id"// optional | nullable | integer | existing file id
            "qbd_discount_id"// optional | nullable | integer | existing Quickbook Discount Item id
            "tab_title"// optional | nullable | string
            "line_discount": {  // optional | nullable | object
                "title"// required | string
                "description"// optional | nullable | string
                "type"// required | string
                "amount"// required | string | numeric | example: "0.00"
            }
        }
    ]
    "add_on_options": [// optional | nullable | array of objects
        {
            "is_selected"// required | boolean
            "is_default"// required | boolean
            "group_number"// required | integer
            "title"// optional | nullable | string
            "description"// optional | nullable | string
            "photo_id"// optional | nullable | integer | existing file id
            "tab_title"// optional | nullable | string
        }
    ]
    "line_items": [ // optional | nullable | array of objects | required if company xero is enabled and not_optional_line_items is not set
        {
            "line_number"// required | nullable | integer
            "line_type"// optional | nullable | string | accepatable_values: item, group
            "line_title"// required | nullable | string
            "line_description"// optional | nullable | string
            "line_price_visibility"// required | nullable | string | accepatable_values: all, component, group
            "line_visibility"// required | nullable | string | accepatable_values: all, component, group
            "line_quantity"// nullable | numeric
            "is_selected"// nullable | boolean
            "is_optional"// nullable | boolean
            "qbo_group_item_ref"// optional | nullable | string
            "source"// optional | nullable | integer
            "group_number"// nullable | integer
            "commission_amount"// nullable | string | numeric | example: "0.00"
            "hvi_amount"// string | numeric | example: "0.00"
            "pricebook_id" // nullable | integer | existing  Pricebook id
            "flat_rate_job_id" // nullable | integer | existing pricebook flat rate job id
            "line_components": [
                {
                    "id"// required | integer | existing item id
                    "title"// optional | string |
                    "description"// optional | string | required if title is not set
                    "xero_sales_account"// optional | nullable | string | max:1000
                    "xero_tax_account"// optional | nullable | string | max:1000
                    "tax_rate"// optional | string | max:1000 | example: "0.00"
                    "file_ids"// optional | array | description: array of existing file ids
                    "price_update_method"// nullable | string | accepatable_values: set_price_manually,automatic_markup,use_cmp_pricing
                    "automatic_markup_percentage"// nullable | string | required, if price_update_method is automatic_markup
                    "line_discount"// nullable | array
                    "line_surcharge"// nullable | array
                    "serialized_inventory_id"// nullable | integer
                    "qbo_line_item_id"// nullable | integer
                    "qbo_sales_tax_code_id"//  optional | nullable | integer | existing Quickbook Tax Code id
                    "unit_price"// required | numeric
                    "quantity"// required | numeric
                    "taxable" // required | boolean
                }
            ]
        }
    ]
    "optional_line_items": [
        {
            "line_number"// required | nullable | integer
            "line_type"// optional | nullable | string | accepatable_values: item, group
            "line_title"// required | nullable | string
            "line_description"// optional | nullable | string
            "line_price_visibility"// required | nullable | string | accepatable_values: all, component, group
            "line_visibility"// required | nullable | string | accepatable_values: all, component, group
            "line_quantity"// nullable | numeric
            "is_selected"// nullable | boolean
            "is_optional"// nullable | boolean
            "qbo_group_item_ref"// optional | nullable | string
            "source"// optional | nullable | integer
            "group_number"// nullable | integer
            "commission_amount"// nullable | string | numeric | example: "0.00"
            "hvi_amount"// string | numeric | example: "0.00"
            "pricebook_id" // nullable | integer | existing  Pricebook id
            "flat_rate_job_id" // nullable | integer | existing pricebook flat rate job id
            "line_components": [
                {
                    "id"// required | integer | existing item id
                    "title"// optional | string |
                    "description"// optional | string | required if title is not set
                    "xero_sales_account"// optional | nullable | string | max:1000
                    "xero_tax_account"// optional | nullable | string | max:1000
                    "tax_rate"// optional | string | max:1000 | example: "0.00"
                    "file_ids"// optional | array | description: array of existing file ids
                    "price_update_method"// nullable | string | accepatable_values: set_price_manually,automatic_markup,use_cmp_pricing
                    "automatic_markup_percentage"// nullable | string | required, if price_update_method is automatic_markup
                    "line_discount"// nullable | array
                    "line_surcharge"// nullable | array
                    "serialized_inventory_id"// nullable | integer
                    "qbo_line_item_id"// nullable | integer
                    "qbo_sales_tax_code_id"//  optional | nullable | integer | existing Quickbook Tax Code id
                    "unit_price"// required | numeric
                    "quantity"// required | numeric
                    "taxable" // required | boolean
                }
            ]
        }
    ]
    "not_optional_line_items": [
        {
            "line_number"// required | nullable | integer
            "line_type"// optional | nullable | string | accepatable_values: item, group
            "line_title"// required | nullable | string
            "line_description"// optional | nullable | string
            "line_price_visibility"// required | nullable | string | accepatable_values: all, component, group
            "line_visibility"// required | nullable | string | accepatable_values: all, component, group
            "line_quantity"// nullable | numeric
            "is_selected"// nullable | boolean
            "is_optional"// nullable | boolean
            "qbo_group_item_ref"// optional | nullable | string
            "source"// optional | nullable | integer
            "group_number"// nullable | integer
            "commission_amount"// nullable | string | numeric | example: "0.00"
            "hvi_amount"// string | numeric | example: "0.00"
            "pricebook_id" // nullable | integer | existing  Pricebook id
            "flat_rate_job_id" // nullable | integer | existing pricebook flat rate job id
            "line_components": [
                {
                    "id"// required | integer | existing item id
                    "title"// optional | string |
                    "description"// optional | string | required if title is not set
                    "xero_sales_account"// optional | nullable | string | max:1000
                    "xero_tax_account"// optional | nullable | string | max:1000
                    "tax_rate"// optional | string | max:1000 | example: "0.00"
                    "file_ids"// optional | array | description: array of existing file ids
                    "price_update_method"// nullable | string | accepatable_values: set_price_manually,automatic_markup,use_cmp_pricing
                    "automatic_markup_percentage"// nullable | string | required, if price_update_method is automatic_markup
                    "line_discount"// nullable | array
                    "line_surcharge"// nullable | array
                    "serialized_inventory_id"// nullable | integer
                    "qbo_line_item_id"// nullable | integer
                    "qbo_sales_tax_code_id"//  optional | nullable | integer | existing Quickbook Tax Code id
                    "unit_price"// required | numeric
                    "quantity"// required | numeric
                    "taxable" // required | boolean
                }
            ]
        }
    ]
    "payments": [// optional | nullable | array of objects
        {
            "invoice_id"// required | integer | existing invoice id
            "payment_date"// required | timestamp
            "amount"// required | string | numeric | example: "1.00"
            "method"// required | string | accepatable_values: cash,check,card,square,bank_transfer,other
            "payment_method_id"// optional | nullable | integer | existing payment method id
            "qbd_discount_account_id"// optional | nullable | integer | required if qbd_discount_amount is set | existing Quickbooks Account id
            "qbd_discount_amount"// optional | nullable | string |  numeric | example: "1.00"
            "notes"// optional | string |  max:4000
            "square_transaction_id"// optional | string |  max:4000
            "can_sync_with_integrations"// optional | nullable |  boolean
        }
    ],
    "customfields": [ // optional | array | description: array of custom fleds
        {
            "id" // optional | nullable | required if field_instance_id is not set | integer | custom field id
            "field_instance_id" // optional | nullable | required if id is not set | integer | custom field instance id
            "value" // required | string | custom value
        },
        {
            "id" // optional | nullable | required if field_instance_id is not set | integer | custom field id
            "field_instance_id" // optional | nullable | required if id is not set | integer | custom field instance id
            "value" // required | string | custom value
        }
    ],
    // THis is for sending invoice via email
    "emaildata": {// optional | nullable | object
        "from_name"// required | string | max:255
        "from_email"// required| email | max:255
        "to_email"// required| email | max:255
        "cc_address"// optional | comma separated emails
        "bcc_address"// optional | comma separated emails
        "subject"// required | string | max:500
        "body"// required | string
        "payment_request_amount"// optional | nullable | numeric | min:0
        "payment_request_amount_type"// optional | nullable | string | accepatable_values: amount, percent
        "attachment_ids"// optional | nullable | array | existing file ids
        "visible_file_ids"// optional | nullable | array | existing file ids
        "attach_dynamic_url_to_email"// optional | nullable | boolean
        "show_signature_request"// optional | nullable | boolean
        "show_payment_request"// optional | nullable | boolean
        "is_credit_card_payment_enabled"// optional | nullable | boolean
        "is_ach_payment_enabled"// optional | nullable | boolean
        "is_pdf_send_mode"// optional | nullable | boolean
        "is_dynamic_send_mode"// optional | nullable | boolean
        "include_invoice_pdf"// optional | nullable | boolean
        "is_card_fee_recovery_enabled"// optional | nullable | boolean
    }
}

Authorizations

x-api-key · string · header · required

Path Parameters

invoiceId · string · required

Body

application/json

tax_rate · string · required

A number, sent as a string.

customer_id · integer | null

Required if job_id is not set and is_template is not set or false. Existing customer id.

job_id · integer | null

Required if is_template is not set or false. Existing job id.

status · enum<integer>

2 = draft, 3 = invoiced, 4 = paid, 5 = partialy paid, 6 = void.

Available options: 2, 3, 4, 5, 6

status_id · integer

Existing invoice type custom status id.

status_workflow_id · integer

Existing invoice type status workflow id.

notes · string

Maximum string length: 4000

invoiced_date · integer | null

Unix timestamp.

due_date · integer | null

Unix timestamp.

is_template · boolean

If true, the invoice will be template.

title · string

Maximum string length: 255

author_id · integer | null

Existing user id.

location_id · integer | null

Existing location id.

contract_id · integer | null

Existing contract id.

commission_type · integer

Required range: 0 <= x <= 3

commission_percent · integer

Required range: 0 <= x <= 100

invoice_use_logo · boolean | null

invoice_show_line_item_unit_price · boolean | null

invoice_show_line_item_qty · boolean | null

invoice_show_line_item_taxed · boolean | null

invoice_show_line_item_total · boolean | null

invoice_show_line_item_desc · boolean | null

invoice_show_line_item_sku · boolean | null

invoice_show_total_tax · boolean | null

invoice_show_job_title · boolean | null

invoice_show_job_location · boolean | null

invoice_show_assigned_members · boolean | null

invoice_show_author · boolean | null

invoice_show_service_address · boolean | null

invoice_contract_signature_lines · integer

Required range: 0 <= x <= 2

invoice_amount_due_display_type · enum<string>

Available options: remaining_balance, set_amount, percentage_of_total, none

invoice_amount_due_display_value · string

invoice_pdf_title · string

Maximum string length: 100

estimate_status · integer

theme_id · integer | null

Existing theme id.

internal_notes · string | null

reference · string | null

hvi · number

company_profile_id · integer | null

Existing alternate company profile id.

maintenance_agreement_id · integer | null

Existing maintenance agreement id.

maintenance_occurrence_id · integer | null

Existing maintenance occurrence id.

occurrence_date · string | null

Required when maintenance agreement id is set and maintenance occurrence id is empty.

qbd_class_id · integer | null

Existing Quickbook Class id.

qbd_discount_id · integer | null

Existing Quickbook Discount Item id.

qbo_sales_tax_code_id · integer | null

Existing Quickbook Tax Code id.

display_settings · object | null

Hide child attributes

display_settings. show_payment_button · boolean · required

display_settings. show_signature_button · boolean · required

display_settings. show_company_title · boolean

display_settings. is_customer_phone_visible · boolean

display_settings. is_modified_customer · boolean

display_settings. modified_customer_display_name · string

display_settings. modified_customer_display_address · string

estimate_display_settings · object | null

Hide child attributes

estimate_display_settings. show_payment_button · boolean · required

estimate_display_settings. show_company_title · boolean

estimate_display_settings. is_customer_phone_visible · boolean

expenses · object[] | null

Hide child attributes

expenses. amount · string · required

A number, sent as a string.

expenses. title · string · required

Required string length: 3 - 60

expenses. type · enum<string> · required

Available options: service, product

expenses. description · string

Maximum string length: 1000

options · object[] | null

Hide child attributes

options. is_selected · boolean · required

options. is_default · boolean · required

options. group_number · integer · required

options. title · string | null

options. description · string | null

options. photo_id · integer | null

Existing file id.

options. qbd_discount_id · integer | null

Existing Quickbook Discount Item id.

options. tab_title · string | null

options. line_discount · object | null

Hide child attributes

options.line_discount. title · string · required

options.line_discount. type · string · required

options.line_discount. amount · string · required

A number, sent as a string.

options.line_discount. description · string | null

add_on_options · object[] | null

Hide child attributes

add_on_options. is_selected · boolean · required

add_on_options. is_default · boolean · required

add_on_options. group_number · integer · required

add_on_options. title · string | null

add_on_options. description · string | null

add_on_options. photo_id · integer | null

Existing file id.

add_on_options. tab_title · string | null

line_items · object[] | null

Required if company xero is enabled and not_optional_line_items is not set.

Hide child attributes

line_items. line_number · integer | null · required

line_items. line_title · string | null · required

line_items. line_price_visibility · enum<string> | null · required

Available options: all, component, group

line_items. line_visibility · enum<string> | null · required

Available options: all, component, group

line_items. line_type · enum<string> | null

Available options: item, group

line_items. line_description · string | null

line_items. line_quantity · number | null

line_items. is_selected · boolean | null

line_items. is_optional · boolean | null

line_items. qbo_group_item_ref · string | null

line_items. source · integer | null

line_items. group_number · integer | null

line_items. commission_amount · string | null

A number, sent as a string.

line_items. hvi_amount · string

A number, sent as a string.

line_items. pricebook_id · integer | null

Existing Pricebook id.

line_items. flat_rate_job_id · integer | null

Existing pricebook flat rate job id.

line_items. line_components · object[]

Hide child attributes

line_items.line_components. id · integer · required

Existing item id.

line_items.line_components. unit_price · number · required

line_items.line_components. quantity · number · required

line_items.line_components. taxable · boolean · required

line_items.line_components. title · string

line_items.line_components. description · string

Required if title is not set.

line_items.line_components. xero_sales_account · string | null

Maximum string length: 1000

line_items.line_components. xero_tax_account · string | null

Maximum string length: 1000

line_items.line_components. tax_rate · string

Maximum string length: 1000

line_items.line_components. file_ids · integer[]

Array of existing file ids.

line_items.line_components. price_update_method · enum<string> | null

Available options: set_price_manually, automatic_markup, use_cmp_pricing

line_items.line_components. automatic_markup_percentage · string | null

Required if price_update_method is automatic_markup.

line_items.line_components. line_discount · any[] | null

line_items.line_components. line_surcharge · any[] | null

line_items.line_components. serialized_inventory_id · integer | null

line_items.line_components. qbo_line_item_id · integer | null

line_items.line_components. qbo_sales_tax_code_id · integer | null

Existing Quickbook Tax Code id.

optional_line_items · object[]

Hide child attributes

optional_line_items. line_number · integer | null · required

optional_line_items. line_title · string | null · required

optional_line_items. line_price_visibility · enum<string> | null · required

Available options: all, component, group

optional_line_items. line_visibility · enum<string> | null · required

Available options: all, component, group

optional_line_items. line_type · enum<string> | null

Available options: item, group

optional_line_items. line_description · string | null

optional_line_items. line_quantity · number | null

optional_line_items. is_selected · boolean | null

optional_line_items. is_optional · boolean | null

optional_line_items. qbo_group_item_ref · string | null

optional_line_items. source · integer | null

optional_line_items. group_number · integer | null

optional_line_items. commission_amount · string | null

A number, sent as a string.

optional_line_items. hvi_amount · string

A number, sent as a string.

optional_line_items. pricebook_id · integer | null

Existing Pricebook id.

optional_line_items. flat_rate_job_id · integer | null

Existing pricebook flat rate job id.

optional_line_items. line_components · object[]

Hide child attributes

optional_line_items.line_components. id · integer · required

Existing item id.

optional_line_items.line_components. unit_price · number · required

optional_line_items.line_components. quantity · number · required

optional_line_items.line_components. taxable · boolean · required

optional_line_items.line_components. title · string

optional_line_items.line_components. description · string

Required if title is not set.

optional_line_items.line_components. xero_sales_account · string | null

Maximum string length: 1000

optional_line_items.line_components. xero_tax_account · string | null

Maximum string length: 1000

optional_line_items.line_components. tax_rate · string

Maximum string length: 1000

optional_line_items.line_components. file_ids · integer[]

Array of existing file ids.

optional_line_items.line_components. price_update_method · enum<string> | null

Available options: set_price_manually, automatic_markup, use_cmp_pricing

optional_line_items.line_components. automatic_markup_percentage · string | null

Required if price_update_method is automatic_markup.

optional_line_items.line_components. line_discount · any[] | null

optional_line_items.line_components. line_surcharge · any[] | null

optional_line_items.line_components. serialized_inventory_id · integer | null

optional_line_items.line_components. qbo_line_item_id · integer | null

optional_line_items.line_components. qbo_sales_tax_code_id · integer | null

Existing Quickbook Tax Code id.

not_optional_line_items · object[]

Hide child attributes

not_optional_line_items. line_number · integer | null · required

not_optional_line_items. line_title · string | null · required

not_optional_line_items. line_price_visibility · enum<string> | null · required

Available options: all, component, group

not_optional_line_items. line_visibility · enum<string> | null · required

Available options: all, component, group

not_optional_line_items. line_type · enum<string> | null

Available options: item, group

not_optional_line_items. line_description · string | null

not_optional_line_items. line_quantity · number | null

not_optional_line_items. is_selected · boolean | null

not_optional_line_items. is_optional · boolean | null

not_optional_line_items. qbo_group_item_ref · string | null

not_optional_line_items. source · integer | null

not_optional_line_items. group_number · integer | null

not_optional_line_items. commission_amount · string | null

A number, sent as a string.

not_optional_line_items. hvi_amount · string

A number, sent as a string.

not_optional_line_items. pricebook_id · integer | null

Existing Pricebook id.

not_optional_line_items. flat_rate_job_id · integer | null

Existing pricebook flat rate job id.

not_optional_line_items. line_components · object[]

Hide child attributes

not_optional_line_items.line_components. id · integer · required

Existing item id.

not_optional_line_items.line_components. unit_price · number · required

not_optional_line_items.line_components. quantity · number · required

not_optional_line_items.line_components. taxable · boolean · required

not_optional_line_items.line_components. title · string

not_optional_line_items.line_components. description · string

Required if title is not set.

not_optional_line_items.line_components. xero_sales_account · string | null

Maximum string length: 1000

not_optional_line_items.line_components. xero_tax_account · string | null

Maximum string length: 1000

not_optional_line_items.line_components. tax_rate · string

Maximum string length: 1000

not_optional_line_items.line_components. file_ids · integer[]

Array of existing file ids.

not_optional_line_items.line_components. price_update_method · enum<string> | null

Available options: set_price_manually, automatic_markup, use_cmp_pricing

not_optional_line_items.line_components. automatic_markup_percentage · string | null

Required if price_update_method is automatic_markup.

not_optional_line_items.line_components. line_discount · any[] | null

not_optional_line_items.line_components. line_surcharge · any[] | null

not_optional_line_items.line_components. serialized_inventory_id · integer | null

not_optional_line_items.line_components. qbo_line_item_id · integer | null

not_optional_line_items.line_components. qbo_sales_tax_code_id · integer | null

Existing Quickbook Tax Code id.

payments · object[] | null

Hide child attributes

payments. invoice_id · integer · required

Existing invoice id.

payments. payment_date · integer · required

Unix timestamp.

payments. amount · string · required

A number, sent as a string.

payments. method · enum<string> · required

Available options: cash, check, card, square, bank_transfer, other

payments. payment_method_id · integer | null

Existing payment method id.

payments. qbd_discount_account_id · integer | null

Required if qbd_discount_amount is set. Existing Quickbooks Account id.

payments. qbd_discount_amount · string | null

A number, sent as a string.

payments. notes · string

Maximum string length: 4000

payments. square_transaction_id · string

Maximum string length: 4000

payments. can_sync_with_integrations · boolean | null

customfields · object[]

Array of custom fields.

Hide child attributes

customfields. value · string · required

Custom value.

customfields. id · integer | null

Required if field_instance_id is not set. Custom field id.

customfields. field_instance_id · integer | null

Required if id is not set. Custom field instance id.

emaildata · object | null

Hide child attributes

emaildata. from_name · string · required

Maximum string length: 255

emaildata. from_email · string<email> · required

Maximum string length: 255

emaildata. to_email · string<email> · required

Maximum string length: 255

emaildata. subject · string · required

Maximum string length: 500

emaildata. body · string · required

emaildata. cc_address · string

Comma separated emails.

emaildata. bcc_address · string

Comma separated emails.

emaildata. payment_request_amount · number | null

Required range: x >= 0

emaildata. payment_request_amount_type · enum<string> | null

Available options: amount, percent

emaildata. attachment_ids · integer[] | null

Existing file ids.

emaildata. visible_file_ids · integer[] | null

Existing file ids.

emaildata. attach_dynamic_url_to_email · boolean | null

emaildata. show_signature_request · boolean | null

emaildata. show_payment_request · boolean | null

emaildata. is_credit_card_payment_enabled · boolean | null

emaildata. is_ach_payment_enabled · boolean | null

emaildata. is_pdf_send_mode · boolean | null

emaildata. is_dynamic_send_mode · boolean | null

emaildata. include_invoice_pdf · boolean | null

emaildata. is_card_fee_recovery_enabled · boolean | null

Response

200

application/json

Successful response

error · boolean

false when the request succeeds.

Example:

false

response · object

The updated record.