Purpose
Parameters
view
string
1
View of object your would like to be returned.
Possible values
- default
- client_read
- planox_client_read_profile
- planox_client_read_tours
- planox_client_read_branding
- planox_client_read_preferences
- contract_type_view
id
integer
3
required
id of record that is being updated.
token
string
100
required
Authentication token for either an application or session.
application
string
200
Slug of application being requested. This is used to determine the role being used to make the request and therefore evaluate if the requester has the correct permissions.
Possible values
- planoauth
- planoorder
- planox2
active
boolean
200
Active status of company
session_view
string
300
View of session object you would like returned.
parent_id
integer
300
Description needed
billing_parent_id
integer
400
Description needed
designation_id
integer
500
Description needed
internal_notes
string
600
Description needed
job_completion_email
string
700
Description needed
confirmation_email_custom_message
string
800
Description needed
branding_name
string
2400
If a client wishes to override their company's branding name, they can do it with this field.
branding_website
string
2500
If a client wishes to override their company's branding website, they can do it with this field.
branding_notes
string
2600
If a client wishes to override their company's branding notes, they can do it with this field.
branding_phone
string
2700
If a client wishes to override their company's branding phone, they can do it with this field.
branding_address
string
2800
If a client wishes to override their company's branding street address, they can do it with this field.
branding_address2
string
2900
If a client wishes to override their company's branding street2 address, they can do it with this field.
branding_city
string
3000
If a client wishes to override their company's branding city, they can do it with this field.
branding_province_iso
string
3100
If a client wishes to override their company's branding province, they can do it with this field.
branding_postal_code
string
3200
If a client wishes to override their company's branding postal_code, they can do it with this field.
billing_name
string
12400
If a client wishes to override their company's billing name, they can do it with this field.
billing_email
string
12500
If a client wishes to override their company's billing email, they can do it with this field.
billing_notes
string
12600
If a client wishes to override their company's billing notes, they can do it with this field.
global_discount_percent
float
12610
Needs description
corp_contribution_rule
string
12620
Needs description
corp_contribution_variable
string
12630
Needs description
corp_contribution_fixed
string
12640
Needs description
headline_planoorder
string
12650
Needs description
billing_address
string
12800
If a client wishes to override their company's billing street address, they can do it with this field.
billing_address2
string
12900
If a client wishes to override their company's billing street2 address, they can do it with this field.
billing_city
string
13000
If a client wishes to override their company's billing city, they can do it with this field.
billing_province_iso
string
13100
If a client wishes to override their company's billing province, they can do it with this field.
billing_postal_code
string
13200
If a client wishes to override their company's billing postal_code, they can do it with this field.