The nightly event occurs

Webhook

This is an event that is kicked off nightly for each quote.

This event only occurs for new and open quotes. Won or lost quotes will not fire this event.

Internally, this event is used for updating caches, consistency checks etc.
Externally, you can choose to hook into this event and use it for whatever you would like.

Note these fields:

context_str = quote
context_id = ... (this will be the quote_id of the quote)
event = nightly

Request

application/json

Body

context_str string

context_id integer

event string

data

object

quote

object

quote_id integer

refnumber string

external_key string

paycycle string

nickname string

customer_id integer

write_datetime string

date date

validuntil_date date

holduntil_datetime_str string

currency_id integer

currency_symbol string

currency_iso4217 string

terms_id integer

class_id integer

terms_name string

terms_days integer

brand_id integer

paycycle_name string

admin_id integer

admin_name string

token string

bill_addr1 string

bill_addr2 string

bill_addr3 string

bill_city string

bill_state string

bill_postcode string

bill_country string

bill_notes string

bill_block string

ship_addr1 string

ship_addr2 string

ship_addr3 string

ship_city string

ship_state string

ship_postcode string

ship_country string

ship_notes string

ship_block string

url_permalink string

url_pdflink string

url_self string

url_acceptlink string

url_paylink string

url_rejectlink string

url_acceptredirect string

url_rejectredirect string

won_datetime string

lost_datetime string

due_date date

setup float

total float

upfront float

subtotal float

taxes float

quote_status_name string

quote_status_str string

quote_status_state string

memo string

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

line_items array

customer

object

customer_id integer

parent_customer_id integer

token string

superuser_id integer

external_key string

display_as string

company string

language_id integer

currency_id integer

currency_iso4217 string

currency_symbol string

class_id integer

admin_id integer

campaign_id integer

campaign_details string

superuser_username string

superuser_email string

superuser_name string

superuser_first_name string

superuser_last_name string

superuser_phone string

superuser_token string

superuser_title string

bill_addr1 string

bill_addr2 string

bill_addr3 string

bill_city string

bill_state string

bill_postcode string

bill_country string

bill_block string

ship_addr1 string

ship_addr2 string

ship_addr3 string

ship_city string

ship_state string

ship_postcode string

ship_country string

ship_block string

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

write_datetime string

write_ipaddr string

mod_datetime string

mod_ipaddr string

brand_id integer

class_name string

terms_id integer

terms_name string

terms_days integer

url_statementlink string

url_paymethodlink string

url_self string

admin_name string

admin_email string

customer_status_id integer

customer_status_name string

customer_status_str string

customer_status_state string

default_paymethod string

default_creditcard_id integer

default_ach_id integer

no_taxes boolean

no_dunning boolean

no_latefees boolean

no_procfees boolean

invoice_delivery string

Possible values: [print, email]

dunning_delivery string

Possible values: [print, email]

tax_ident string

total float

balance float

paid float

mrr float

arr float

tags string[]

invoices

object

invoice_id integer

refnumber string

external_key string

invoice_index integer

package_id integer

customer_id integer

brand_id integer

brand_name string

write_datetime string

mod_datetime string

void_datetime string

date date

currency_id integer

currency_symbol string

currency_iso4217 string

class_id integer

class_name string

paycycle string

paycycle_name string

terms_id integer

terms_name string

terms_days integer

admin_id integer

admin_name string

token string

bill_addr1 string

bill_addr2 string

bill_addr3 string

bill_city string

bill_state string

bill_postcode string

bill_country string

bill_notes string

bill_block string

ship_addr1 string

ship_addr2 string

ship_addr3 string

ship_city string

ship_state string

ship_postcode string

ship_country string

ship_notes string

ship_block string

cycle_pre_from_date date

cycle_pre_to_date date

cycle_this_date date

cycle_post_from_date date

cycle_post_to_date date

url_permalink string

url_pdflink string

url_paylink string

url_self string

is_paid boolean

is_void boolean

is_overdue boolean

due_date date

days_overdue integer

paid_date date

balance float

applied float

total float

subtotal float

taxes float

credits float

payments float

writeoffs float

refunds float

overdue float

declines integer

sum_base float

sum_usage float

sum_onetime float

invoice_status_name string

invoice_status_str string

invoice_status_state string

memo string

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

line_items array

schedule array

tags string[]

packages

object

package_id integer

customer_id integer

brand_id integer

brand_name string

class_id integer

class_name string

external_key string

token string

nickname string

paymethod string

paymethod_name string

paymethod_detail string

creditcard_id integer

ach_id integer

tokenized_id integer

admin_id integer

admin_name string

bill_addr1 string

bill_addr2 string

bill_addr3 string

bill_city string

bill_state string

bill_postcode string

bill_country string

bill_notes string

ship_addr1 string

ship_addr2 string

ship_addr3 string

ship_city string

ship_state string

ship_postcode string

ship_country string

ship_notes string

currency_id integer

currency_iso4217 string

currency_symbol string

amount_collected float

amount_invoiced float

amount_due float

amount_overdue float

suspendfrom_datetime string

suspendto_datetime string

next_invoice_datetime string

is_overdue boolean

days_overdue integer

start_datetime string

cancel_datetime string

write_datetime string

mod_datetime string

holduntil_datetime string

package_status_id integer

package_status_name string

package_status_str string

package_status_state string

mrr float

arr float

cancel_reason string

terms_id integer

terms_name string

terms_days integer

paycycle string

paycycle_name string

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

first_invoice_schedule_template_id integer

recurring_invoice_schedule_template_id integer

line_items array

tags string[]

url_self string

security_token string

Responses

Return a 200 status to indicate that the data was received successfully

The nightly event occurs

Request​

Body

Responses​

Request

Responses