API documentation

_others

POST /api/login

Simple form authentication

Documentation
Sandbox

Documentation

Authenticate using basic form login and retrieve an authorization token through the response header.

Parameters

Parameter	Type	Required?	Format	Description
username	string	true		Username to login with
password	string	true		Password to login with

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/configuration

Get the list of categories.

Documentation
Sandbox

Documentation

Get the list of categories.

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/entries/{id}

Get a single timesheet entry.

Documentation
Sandbox

Documentation

Get a single timesheet entry.

Requirements

Name	Requirement	Type	Description
id

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/flights

Get flights by number and departure date.

Documentation
Sandbox

Documentation

Get flights by number and departure date.

Filters

Name

Information

flightNumber

Requirement	[\w\d]+
Description	The flight number to get flight options for

date

Requirement	\d{4}-\d{2}-\d{2}
Description	The date of departure (YYYY-MM-DD)

Return

Parameter	Type	Versions	Description
200 - Successful transaction
flight	string	*
report_id	integer	*	Returns only the corresponding report id.
localized_departure	DateTime	*	Get the departure date in it's own timezone.
localized_arrival	DateTime	*	Get the arrival date in it's own timezone.
id	integer	*
vehicle	integer	*
origin	object (Place)	*
origin[label]	string	*
origin[id]	integer	*
origin[country]	string	*
origin[city]	string	*
origin[google_id]	string	*
origin[type]	string	*
origin[country_code]	string	*
origin[timezone]	string	*
origin[latitude]	float	*
origin[longitude]	float	*
origin[whitelisted]	boolean	*
destination	object (Place)	*
departure	DateTime	*
arrival	DateTime	*
duration_minutes	integer	*
ticket	object (Media)	*
ticket[name]	string	*
ticket[width]	integer	*
ticket[height]	integer	*
ticket[creation_date]	DateTime	*
ticket[content_type]	string	*
ticket[size]	integer	*
ticket[id]	integer	*
ticket[hash]	string	*
ticket[providerReference]		*
ticket[providerStatus]		*
violations[]	array of objects (BusinessRule)	*
violations[][id]	integer	*
violations[][type]	integer	*
violations[][description]	string	*
violations[][field]	string	*
violations[][roles]	array	*
hash	string	*
transit	boolean	*

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/logout

Logout and invalidate token.

Documentation
Sandbox

Documentation

Logout and invalidate token.

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v4/me

Edit an user entity.

Documentation
Sandbox

Documentation

Edit an user entity.

Return

Parameter	Type	Versions	Description
200 - Successful transaction
id	integer	*
selectedOrganization		*
roles	array	*
username	string	*
firstName		*
lastName		*
email	string	>=4	{@inheritdoc}
fullName	string	*	Get full name.
locale	string	*
enabled	boolean	*
code	string	*
milestoneParts	array	*
profilePicture	string	*
tenant		*
initials	string	*
prefix	string	*
plainPassword		*
registrationCode		*
code2		*
accountNumber		*
emailAlternative		*
profile_picture	string	*
tenant_id	integer	*
first_name	string	*
last_name	string	*
groups[]	array of objects (Group)	*
groups[][id]	integer	*
groups[][name]	string	*
groups[][enabled]	boolean	*
groups[][code]	string	*
groups[][creation_date]	DateTime	*
selected_organization	object (Organization)	*
selected_organization[tags]	array	>=4
selected_organization[id]	integer	*
selected_organization[name]	string	*
selected_organization[subdomain]	string	*
selected_organization[domain]	string	*
selected_organization[address]	string	*
selected_organization[zipcode]	string	*
selected_organization[city]	string	*
selected_organization[locale]	string	*
selected_organization[telephone]	string	*
selected_organization[email]	string	*
selected_organization[holidays][]	array of objects (Holiday)	*	One Organisation has Many Holidays.
selected_organization[holidays][][id]	integer	*
selected_organization[holidays][][name]	string	*
selected_organization[holidays][][holiday_periods][]	array of objects (HolidayPeriod)	*	One Holiday has Many Periods.
selected_organization[holidays][][holiday_periods][][id]	integer	*
selected_organization[holidays][][holiday_periods][][year]	integer	*
selected_organization[holidays][][holiday_periods][][start]	DateTime	*
selected_organization[holidays][][holiday_periods][][end]	DateTime	*
selected_organization[holidays][][groups][]	array of objects (Group)	*
selected_organization[holidays][][enabled]	boolean	*
selected_organization[categories][]	array of objects (Category)	*
selected_organization[categories][][id]	integer	*
selected_organization[categories][][name]	string	*
selected_organization[categories][][explanation]	string	*
selected_organization[categories][][code]	string	*
selected_organization[categories][][code2]	string	*
selected_organization[categories][][code3]	string	*
selected_organization[categories][][code4]	string	*
selected_organization[categories][][enabled]	boolean	*
selected_organization[categories][][groups][]	array of objects (Group)	*
selected_organization[categories][][vats][]	array of objects (Vat)	*
selected_organization[categories][][vats][][id]	integer	*
selected_organization[categories][][vats][][name]	string	*
selected_organization[categories][][vats][][percentage]	float	*
selected_organization[categories][][vats][][enabled]	boolean	*
selected_organization[categories][][vats][][country]	string	*
selected_organization[categories][][vats][][code]		*
selected_organization[categories][][vats][][code2]		*
selected_organization[categories][][vat_fixed]	boolean	*
selected_organization[categories][][types][]	array of integers	*
selected_organization[categories][][resource_required]	boolean	*
selected_organization[categories][][proof_required]	boolean	*
selected_organization[tag_levels][]	array of objects (TagLevel)	>=3
selected_organization[tag_levels][][id]	integer	*
selected_organization[tag_levels][][index]	integer	*
selected_organization[tag_levels][][name]	string	*
selected_organization[tag_levels][][required]	boolean	*
selected_organization[vats][]	array of objects (Vat)	*
selected_organization[vats][][id]	integer	*
selected_organization[vats][][name]	string	*
selected_organization[vats][][percentage]	float	*
selected_organization[vats][][enabled]	boolean	*
selected_organization[vats][][country]	string	*
selected_organization[vats][][code]		*
selected_organization[vats][][code2]		*
selected_organization[settings]	object (Settings)	*
selected_organization[settings][default_mileage_rate]	float	*
selected_organization[settings][rate_per_mile]	float	<=3
selected_organization[settings][rate_per_kilometer]	float	<=3
selected_organization[settings][id]	integer	*
selected_organization[settings][currency]	string	*
selected_organization[settings][passcode_required]	boolean	*
selected_organization[settings][passcode_length]	integer	*
selected_organization[settings][resource_required]	boolean	*
selected_organization[settings][description_required]	boolean	*
selected_organization[settings][country_enabled]	boolean	*
selected_organization[settings][country_required]	boolean	*
selected_organization[settings][available_countries][]	array of strings	*
selected_organization[settings][category_enabled]	boolean	*
selected_organization[settings][category_required]	boolean	*
selected_organization[settings][tag_enabled]	boolean	>=4
selected_organization[settings][tag_level_check_per_report]	integer	>=4
selected_organization[settings][one_manager_per_report]	boolean	>=4.1
selected_organization[settings][carbon_copy_field_enabled]	boolean	*
selected_organization[settings][payment_method_enabled]	boolean	*
selected_organization[settings][payment_method_required]	boolean	*
selected_organization[settings][app_input_vat]	boolean	*
selected_organization[settings][pdf_one_per_page]	boolean	*
selected_organization[settings][mileage_enabled]	boolean	*
selected_organization[settings][mileage_distance_fixed]	boolean	*
selected_organization[settings][mileage_shortest_distance]	boolean	*
selected_organization[settings][settings_modules][]	array of objects (SettingsModule)	*
selected_organization[settings][settings_modules][][id]	integer	*
selected_organization[settings][settings_modules][][module]	object (Module)	*
selected_organization[settings][settings_modules][][module][id]	integer	*
selected_organization[settings][settings_modules][][module][key]	string	*
selected_organization[settings][settings_modules][][module][name]	string	*
selected_organization[settings][settings_modules][][groups][]	array of objects (Group)	*
selected_organization[settings][legacy_mode]	boolean	*
selected_organization[settings][manager_fixed]	boolean	*
selected_organization[settings][user_advances_enabled]	boolean	*
selected_organization[settings][advance_currency_enabled]	boolean	*
selected_organization[settings][compensation_enabled]	boolean	*
selected_organization[settings][track_billable]	boolean	*
selected_organization[settings][billable_label]	string	>=4
selected_organization[settings][billable_groups][]	array of objects (Group)	>=4
selected_organization[settings][currency_fixed]	boolean	*
selected_organization[settings][signature_required]	boolean	>=4
selected_organization[settings][time_enabled]	boolean	*
selected_organization[settings][time_period]	integer	*
selected_organization[settings][time_start_of_week]	integer	*
selected_organization[settings][help_enabled]	boolean	*
selected_organization[settings][smart_report_enabled]	boolean	*
selected_organization[settings][smart_report_frequence]	object (Frequence)	*
selected_organization[settings][smart_report_frequence][id]	integer	*
selected_organization[settings][smart_report_frequence][period]	integer	*
selected_organization[settings][smart_report_frequence][day]	integer	*
selected_organization[settings][smart_report_frequence][not_before]	DateTime	*
selected_organization[settings][smart_report_frequence][not_after]	DateTime	*
selected_organization[settings][report_default_name]	string	*
selected_organization[settings][trip_default_name]	string	*
selected_organization[settings][default_advance_category]	object (Category)	*
selected_organization[settings][advance_resource_required]	boolean	*
selected_organization[settings][default_region]	object (Place)	*
selected_organization[settings][default_region][label]	string	*
selected_organization[settings][default_region][id]	integer	*
selected_organization[settings][default_region][country]	string	*
selected_organization[settings][default_region][city]	string	*
selected_organization[settings][default_region][google_id]	string	*
selected_organization[settings][default_region][type]	string	*
selected_organization[settings][default_region][country_code]	string	*
selected_organization[settings][default_region][timezone]	string	*
selected_organization[settings][default_region][latitude]	float	*
selected_organization[settings][default_region][longitude]	float	*
selected_organization[settings][default_region][whitelisted]	boolean	*
selected_organization[settings][one_payment_method_per_report]	boolean	>=4.1
selected_organization[settings][max_expenses_per_report]	integer	*
selected_organization[settings][reject_comment_required]	boolean	*
selected_organization[settings][passcodeLength]		*
selected_organization[settings][maxExpensesPerReport]		*
selected_organization[disabled]	boolean	*
selected_organization[adp_account]	object (AdpAccount)	*
selected_organization[adp_account][id]	integer	*
selected_organization[payment_methods][]	array of objects (PaymentMethod)	*
selected_organization[payment_methods][][users][]	array of integers	*	Get id of related users.
selected_organization[payment_methods][][id]	integer	*
selected_organization[payment_methods][][name]	string	*
selected_organization[payment_methods][][code]	string	*
selected_organization[payment_methods][][code2]	string	*
selected_organization[payment_methods][][enabled]	boolean	*
selected_organization[payment_methods][][type]	integer	*
selected_organization[payment_methods][][issuer]	integer	*
selected_organization[payment_methods][][category_expenditure_cash]	object (Category)	*
selected_organization[payment_methods][][category_expenditure_private]	object (Category)	*
selected_organization[payment_methods][][assign_to]	integer	*
selected_organization[payment_methods][][condition]		*
selected_organization[payment_methods][][number]		*
selected_organization[export_formats][]	array of objects (ExportFormat)	*	ArrayCollection $exportFormats.
selected_organization[export_formats][][id]	integer	*
selected_organization[export_formats][][type]	string	*
selected_organization[export_formats][][name]	string	*
selected_organization[export_formats][][file]		*
selected_organization[compensation_types][]	array of objects (CompensationType)	*
selected_organization[compensation_types][][id]	integer	*
selected_organization[compensation_types][][type]	integer	*
selected_organization[compensation_types][][name]	string	*
selected_organization[compensation_types][][min]	integer	*
selected_organization[compensation_types][][currency]	string	*
selected_organization[compensation_types][][max]	integer	*
selected_organization[compensation_types][][step]	float	*
selected_organization[compensation_types][][enabled]	boolean	*
selected_organization[compensation_types][][unit]	integer	*
selected_organization[compensation_types][][rate]	float	*
selected_organization[compensation_types][][rate_fixed]	boolean	*
selected_organization[compensation_types][][vat]	object (Vat)	*
selected_organization[compensation_types][][vat_fixed]	boolean	*
selected_organization[compensation_types][][category_enabled]	boolean	*
selected_organization[compensation_types][][category_required]	boolean	*
selected_organization[compensation_types][][category_fixed]	boolean	*
selected_organization[compensation_types][][category]	object (Category)	*
selected_organization[compensation_types][][tag_enabled]	boolean	>=4
selected_organization[compensation_types][][tag_fixed]	boolean	>=4
selected_organization[compensation_types][][tag1]	object (Tag)	>=4
selected_organization[compensation_types][][tag1][id]	integer	*
selected_organization[compensation_types][][tag1][name]	string	*
selected_organization[compensation_types][][tag1][explanation]	string	*
selected_organization[compensation_types][][tag1][enabled]	boolean	*
selected_organization[compensation_types][][tag1][code]	string	*
selected_organization[compensation_types][][tag1][code2]	string	*
selected_organization[compensation_types][][tag1][code3]	string	*
selected_organization[compensation_types][][tag1][index]	integer	*
selected_organization[compensation_types][][tag1][groups][]	array of objects (Group)	*
selected_organization[compensation_types][][tag1][types][]	array of integers	*
selected_organization[compensation_types][][tag1][parent]	object (Tag)	>=4
selected_organization[compensation_types][][tag1][manager]	object (User)	*
selected_organization[compensation_types][][tag1][manager][username]	string	*
selected_organization[compensation_types][][tag1][manager][fullName]	string	*	Get full name.
selected_organization[compensation_types][][tag1][manager][email]	string	>=4	{@inheritdoc}
selected_organization[compensation_types][][tag1][manager][profile_picture]	string	*
selected_organization[compensation_types][][tag1][manager][tenant_id]	integer	*
selected_organization[compensation_types][][tag1][manager][id]	integer	*
selected_organization[compensation_types][][tag1][manager][initials]	string	*
selected_organization[compensation_types][][tag1][manager][first_name]	string	*
selected_organization[compensation_types][][tag1][manager][prefix]	string	*
selected_organization[compensation_types][][tag1][manager][last_name]	string	*
selected_organization[compensation_types][][tag1][manager][groups][]	array of objects (Group)	*
selected_organization[compensation_types][][tag1][manager][selected_organization]	object (Organization)	*
selected_organization[compensation_types][][tag1][manager][code]	string	*
selected_organization[compensation_types][][tag1][manager][submits_to]	object (User)	*
selected_organization[compensation_types][][tag1][manager][approves_to]	object (User)	*
selected_organization[compensation_types][][tag1][manager][locale]	string	*
selected_organization[compensation_types][][tag1][manager][budget]	float	>=4
selected_organization[compensation_types][][tag1][manager][field_values][]	array of objects (CustomFieldValue)	*
selected_organization[compensation_types][][tag1][manager][field_values][][field_id]	integer	*
selected_organization[compensation_types][][tag1][manager][field_values][][id]	integer	*
selected_organization[compensation_types][][tag1][manager][field_values][][field]	object (CustomField)	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][category_id]	integer	*	This is here for backwards compatibility in the app. Please don't use it.
selected_organization[compensation_types][][tag1][manager][field_values][][field][category_ids][]	array of integers	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][parent_id]	integer	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][parent_option_id]	integer	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][id]	integer	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][name]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][type]	integer	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][order]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][placeholder]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][required]	boolean	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_value]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option]	object (CustomFieldOption)	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option][parent_id]	integer	*	Get parent id.
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option][id]	integer	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option][value]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option][name]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option][text1]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option][text2]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option][enabled]	boolean	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][default_option][groups][]	array of objects (Group)	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][options][]	array of objects (CustomFieldOption)	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][user_editable]	boolean	*	@ORM\Column(name="userEditable", type="boolean")
selected_organization[compensation_types][][tag1][manager][field_values][][field][header_field]	boolean	*	@ORM\Column(name="headerField", type="boolean")
selected_organization[compensation_types][][tag1][manager][field_values][][field][regex]	string	*	@ORM\Column(type="text", nullable=true)
selected_organization[compensation_types][][tag1][manager][field_values][][field][enabled]	boolean	*	@ORM\Column(type="boolean")
selected_organization[compensation_types][][tag1][manager][field_values][][field][key]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][allow_user_default]	boolean	*
selected_organization[compensation_types][][tag1][manager][field_values][][field][sort]		*
selected_organization[compensation_types][][tag1][manager][field_values][][field][defaultValue]		*
selected_organization[compensation_types][][tag1][manager][field_values][][option]	object (CustomFieldOption)	*
selected_organization[compensation_types][][tag1][manager][field_values][][option][parent_id]	integer	*	Get parent id.
selected_organization[compensation_types][][tag1][manager][field_values][][option][id]	integer	*
selected_organization[compensation_types][][tag1][manager][field_values][][option][value]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][option][name]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][option][text1]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][option][text2]	string	*
selected_organization[compensation_types][][tag1][manager][field_values][][option][enabled]	boolean	*
selected_organization[compensation_types][][tag1][manager][field_values][][option][groups][]	array of objects (Group)	*
selected_organization[compensation_types][][tag1][manager][field_values][][value]	string	*
selected_organization[compensation_types][][tag1][manager][default_currency]	string	*
selected_organization[compensation_types][][tag1][manager][default_country]	string	*
selected_organization[compensation_types][][tag1][manager][default_category]	object (Category)	*
selected_organization[compensation_types][][tag1][manager][default_tag1]	object (Tag)	>=4
selected_organization[compensation_types][][tag1][manager][default_tag2]	object (Tag)	>=4
selected_organization[compensation_types][][tag1][manager][default_tag3]	object (Tag)	>=4
selected_organization[compensation_types][][tag1][manager][default_payment_method]	object (PaymentMethod)	*
selected_organization[compensation_types][][tag1][manager][default_from_location]	object (Location)	*
selected_organization[compensation_types][][tag1][manager][default_from_location][id]	integer	*
selected_organization[compensation_types][][tag1][manager][default_from_location][query]	string	*
selected_organization[compensation_types][][tag1][manager][default_from_location][city]	string	*
selected_organization[compensation_types][][tag1][manager][default_from_location][country]	string	*
selected_organization[compensation_types][][tag1][manager][default_from_location][address]	string	*
selected_organization[compensation_types][][tag1][manager][default_from_location][address_number]	string	*
selected_organization[compensation_types][][tag1][manager][default_from_location][order]	integer	*
selected_organization[compensation_types][][tag1][manager][default_from_location][latitude]	float	*
selected_organization[compensation_types][][tag1][manager][default_from_location][longitude]	float	*
selected_organization[compensation_types][][tag1][manager][default_from_location][label]	string	*
selected_organization[compensation_types][][tag1][manager][default_to_location]	object (Location)	*
selected_organization[compensation_types][][tag1][manager][uuid]	string	*
selected_organization[compensation_types][][tag1][manager][firstName]		*
selected_organization[compensation_types][][tag1][manager][lastName]		*
selected_organization[compensation_types][][tag1][manager][plainPassword]		*
selected_organization[compensation_types][][tag1][manager][registrationCode]		*
selected_organization[compensation_types][][tag1][manager][code2]		*
selected_organization[compensation_types][][tag1][manager][accountNumber]		*
selected_organization[compensation_types][][tag1][manager][emailAlternative]		*
selected_organization[compensation_types][][tag1][proof_required]	boolean	*
selected_organization[compensation_types][][tag2]	object (Tag)	>=4
selected_organization[compensation_types][][country]	string	*
selected_organization[compensation_types][][country_fixed]	boolean	*
selected_organization[compensation_types][][files_enabled]	boolean	*
selected_organization[compensation_types][][files_required]	boolean	*
selected_organization[compensation_types][][description_enabled]	boolean	*
selected_organization[compensation_types][][description_required]	boolean	*
selected_organization[compensation_types][][groups][]	array of objects (Group)	*
selected_organization[compensation_types][][code]		*
selected_organization[mileage_rates][]	array of objects (MileageRate)	*
selected_organization[mileage_rates][][mode_of_transport]	string	*
selected_organization[mileage_rates][][id]	integer	*
selected_organization[mileage_rates][][name]	string	*
selected_organization[mileage_rates][][unit]	integer	*
selected_organization[mileage_rates][][rate]	float	*
selected_organization[mileage_rates][][currency]	string	*
selected_organization[mileage_rates][][untaxed]	float	*
selected_organization[mileage_rates][][category]	object (Category)	*
selected_organization[mileage_rates][][groups][]	array of objects (Group)	*
selected_organization[mileage_rates][][enabled]	boolean	*
selected_organization[corporate_identity]	object (CorporateIdentity)	*
selected_organization[corporate_identity][id]	integer	*
selected_organization[corporate_identity][primary_color]	string	*
selected_organization[corporate_identity][logo_color]	string	*
selected_organization[corporate_identity][app_icon]	string	*
selected_organization[corporate_identity][app_main_tint_color]	string	*
selected_organization[corporate_identity][app_secondary_tint_color]	string	*
selected_organization[corporate_identity][app_side_menu_color]	string	*
selected_organization[corporate_identity][app_side_menu_border_color]	string	*
selected_organization[corporate_identity][app_side_menu_top_color]	string	*
selected_organization[corporate_identity][app_expense_button_text_color]	string	*
selected_organization[corporate_identity][app_table_view_background_color]	string	*
selected_organization[corporate_identity][reply_to]	string	*
selected_organization[corporate_identity][from_name]	string	*
selected_organization[corporate_identity][sender_name]	string	*
selected_organization[corporate_identity][regulations]	string	*
selected_organization[corporate_identity][translations][]	array of objects (Translation)	*
selected_organization[corporate_identity][translations][][id]	integer	*
selected_organization[corporate_identity][translations][][key]	string	*
selected_organization[corporate_identity][translations][][locale]	string	*
selected_organization[corporate_identity][translations][][translation]	string	*
selected_organization[corporate_identity][translations][][identity]	object (CorporateIdentity)	*
selected_organization[corporate_identity][submitter_signature]	string	*
selected_organization[corporate_identity][approver_signature]	string	*
selected_organization[activities][]	array of objects (Activity)	*
selected_organization[activities][][id]	integer	*
selected_organization[activities][][hash]	string	*
selected_organization[activities][][name]	string	*
selected_organization[activities][][groups][]	array of objects (Group)	*
selected_organization[activities][][enabled]	boolean	*
selected_organization[activities][][comments_enabled]	boolean	*
selected_organization[activities][][comments_required]	boolean	*
selected_organization[activities][][default]	boolean	*
selected_organization[activities][][days][]	array of integers	*
selected_organization[activities][][holidays_allowed]	boolean	*
selected_organization[activities][][maximum]	integer	*
selected_organization[activities][][future_days]	integer	*
selected_organization[activities][][futureDays]		*
selected_organization[address2]		*
selected_organization[country]		*
selected_organization[taxNumber]		*
selected_organization[iban]		*
submits_to	object (User)	*
submits_to[username]	string	*
submits_to[fullName]	string	*	Get full name.
submits_to[email]	string	>=4	{@inheritdoc}
submits_to[profile_picture]	string	*
submits_to[tenant_id]	integer	*
submits_to[id]	integer	*
submits_to[initials]	string	*
submits_to[first_name]	string	*
submits_to[prefix]	string	*
submits_to[last_name]	string	*
submits_to[groups][]	array of objects (Group)	*
submits_to[selected_organization]	object (Organization)	*
submits_to[code]	string	*
submits_to[submits_to]	object (User)	*
submits_to[approves_to]	object (User)	*
submits_to[locale]	string	*
submits_to[budget]	float	>=4
submits_to[field_values][]	array of objects (CustomFieldValue)	*
submits_to[field_values][][field_id]	integer	*
submits_to[field_values][][id]	integer	*
submits_to[field_values][][field]	object (CustomField)	*
submits_to[field_values][][field][category_id]	integer	*	This is here for backwards compatibility in the app. Please don't use it.
submits_to[field_values][][field][category_ids][]	array of integers	*
submits_to[field_values][][field][parent_id]	integer	*
submits_to[field_values][][field][parent_option_id]	integer	*
submits_to[field_values][][field][id]	integer	*
submits_to[field_values][][field][name]	string	*
submits_to[field_values][][field][type]	integer	*
submits_to[field_values][][field][order]	string	*
submits_to[field_values][][field][placeholder]	string	*
submits_to[field_values][][field][required]	boolean	*
submits_to[field_values][][field][default_value]	string	*
submits_to[field_values][][field][default_option]	object (CustomFieldOption)	*
submits_to[field_values][][field][default_option][parent_id]	integer	*	Get parent id.
submits_to[field_values][][field][default_option][id]	integer	*
submits_to[field_values][][field][default_option][value]	string	*
submits_to[field_values][][field][default_option][name]	string	*
submits_to[field_values][][field][default_option][text1]	string	*
submits_to[field_values][][field][default_option][text2]	string	*
submits_to[field_values][][field][default_option][enabled]	boolean	*
submits_to[field_values][][field][default_option][groups][]	array of objects (Group)	*
submits_to[field_values][][field][options][]	array of objects (CustomFieldOption)	*
submits_to[field_values][][field][user_editable]	boolean	*	@ORM\Column(name="userEditable", type="boolean")
submits_to[field_values][][field][header_field]	boolean	*	@ORM\Column(name="headerField", type="boolean")
submits_to[field_values][][field][regex]	string	*	@ORM\Column(type="text", nullable=true)
submits_to[field_values][][field][enabled]	boolean	*	@ORM\Column(type="boolean")
submits_to[field_values][][field][key]	string	*
submits_to[field_values][][field][allow_user_default]	boolean	*
submits_to[field_values][][field][sort]		*
submits_to[field_values][][field][defaultValue]		*
submits_to[field_values][][option]	object (CustomFieldOption)	*
submits_to[field_values][][option][parent_id]	integer	*	Get parent id.
submits_to[field_values][][option][id]	integer	*
submits_to[field_values][][option][value]	string	*
submits_to[field_values][][option][name]	string	*
submits_to[field_values][][option][text1]	string	*
submits_to[field_values][][option][text2]	string	*
submits_to[field_values][][option][enabled]	boolean	*
submits_to[field_values][][option][groups][]	array of objects (Group)	*
submits_to[field_values][][value]	string	*
submits_to[default_currency]	string	*
submits_to[default_country]	string	*
submits_to[default_category]	object (Category)	*
submits_to[default_category][id]	integer	*
submits_to[default_category][name]	string	*
submits_to[default_category][explanation]	string	*
submits_to[default_category][code]	string	*
submits_to[default_category][code2]	string	*
submits_to[default_category][code3]	string	*
submits_to[default_category][code4]	string	*
submits_to[default_category][enabled]	boolean	*
submits_to[default_category][groups][]	array of objects (Group)	*
submits_to[default_category][vats][]	array of objects (Vat)	*
submits_to[default_category][vats][][id]	integer	*
submits_to[default_category][vats][][name]	string	*
submits_to[default_category][vats][][percentage]	float	*
submits_to[default_category][vats][][enabled]	boolean	*
submits_to[default_category][vats][][country]	string	*
submits_to[default_category][vats][][code]		*
submits_to[default_category][vats][][code2]		*
submits_to[default_category][vat_fixed]	boolean	*
submits_to[default_category][types][]	array of integers	*
submits_to[default_category][resource_required]	boolean	*
submits_to[default_category][proof_required]	boolean	*
submits_to[default_tag1]	object (Tag)	>=4
submits_to[default_tag1][id]	integer	*
submits_to[default_tag1][name]	string	*
submits_to[default_tag1][explanation]	string	*
submits_to[default_tag1][enabled]	boolean	*
submits_to[default_tag1][code]	string	*
submits_to[default_tag1][code2]	string	*
submits_to[default_tag1][code3]	string	*
submits_to[default_tag1][index]	integer	*
submits_to[default_tag1][groups][]	array of objects (Group)	*
submits_to[default_tag1][types][]	array of integers	*
submits_to[default_tag1][parent]	object (Tag)	>=4
submits_to[default_tag1][manager]	object (User)	*
submits_to[default_tag1][proof_required]	boolean	*
submits_to[default_tag2]	object (Tag)	>=4
submits_to[default_tag3]	object (Tag)	>=4
submits_to[default_payment_method]	object (PaymentMethod)	*
submits_to[default_payment_method][users][]	array of integers	*	Get id of related users.
submits_to[default_payment_method][id]	integer	*
submits_to[default_payment_method][name]	string	*
submits_to[default_payment_method][code]	string	*
submits_to[default_payment_method][code2]	string	*
submits_to[default_payment_method][enabled]	boolean	*
submits_to[default_payment_method][type]	integer	*
submits_to[default_payment_method][issuer]	integer	*
submits_to[default_payment_method][category_expenditure_cash]	object (Category)	*
submits_to[default_payment_method][category_expenditure_private]	object (Category)	*
submits_to[default_payment_method][assign_to]	integer	*
submits_to[default_payment_method][condition]		*
submits_to[default_payment_method][number]		*
submits_to[default_from_location]	object (Location)	*
submits_to[default_from_location][id]	integer	*
submits_to[default_from_location][query]	string	*
submits_to[default_from_location][city]	string	*
submits_to[default_from_location][country]	string	*
submits_to[default_from_location][address]	string	*
submits_to[default_from_location][address_number]	string	*
submits_to[default_from_location][order]	integer	*
submits_to[default_from_location][latitude]	float	*
submits_to[default_from_location][longitude]	float	*
submits_to[default_from_location][label]	string	*
submits_to[default_to_location]	object (Location)	*
submits_to[uuid]	string	*
submits_to[firstName]		*
submits_to[lastName]		*
submits_to[plainPassword]		*
submits_to[registrationCode]		*
submits_to[code2]		*
submits_to[accountNumber]		*
submits_to[emailAlternative]		*
approves_to	object (User)	*
budget	float	>=4
field_values[]	array of objects (CustomFieldValue)	*
field_values[][field_id]	integer	*
field_values[][id]	integer	*
field_values[][field]	object (CustomField)	*
field_values[][field][category_id]	integer	*	This is here for backwards compatibility in the app. Please don't use it.
field_values[][field][category_ids][]	array of integers	*
field_values[][field][parent_id]	integer	*
field_values[][field][parent_option_id]	integer	*
field_values[][field][id]	integer	*
field_values[][field][name]	string	*
field_values[][field][type]	integer	*
field_values[][field][order]	string	*
field_values[][field][placeholder]	string	*
field_values[][field][required]	boolean	*
field_values[][field][default_value]	string	*
field_values[][field][default_option]	object (CustomFieldOption)	*
field_values[][field][default_option][parent_id]	integer	*	Get parent id.
field_values[][field][default_option][id]	integer	*
field_values[][field][default_option][value]	string	*
field_values[][field][default_option][name]	string	*
field_values[][field][default_option][text1]	string	*
field_values[][field][default_option][text2]	string	*
field_values[][field][default_option][enabled]	boolean	*
field_values[][field][default_option][groups][]	array of objects (Group)	*
field_values[][field][options][]	array of objects (CustomFieldOption)	*
field_values[][field][user_editable]	boolean	*	@ORM\Column(name="userEditable", type="boolean")
field_values[][field][header_field]	boolean	*	@ORM\Column(name="headerField", type="boolean")
field_values[][field][regex]	string	*	@ORM\Column(type="text", nullable=true)
field_values[][field][enabled]	boolean	*	@ORM\Column(type="boolean")
field_values[][field][key]	string	*
field_values[][field][allow_user_default]	boolean	*
field_values[][field][sort]		*
field_values[][field][defaultValue]		*
field_values[][option]	object (CustomFieldOption)	*
field_values[][option][parent_id]	integer	*	Get parent id.
field_values[][option][id]	integer	*
field_values[][option][value]	string	*
field_values[][option][name]	string	*
field_values[][option][text1]	string	*
field_values[][option][text2]	string	*
field_values[][option][enabled]	boolean	*
field_values[][option][groups][]	array of objects (Group)	*
field_values[][value]	string	*
default_currency	string	*
default_country	string	*
default_category	object (Category)	*
default_category[id]	integer	*
default_category[name]	string	*
default_category[explanation]	string	*
default_category[code]	string	*
default_category[code2]	string	*
default_category[code3]	string	*
default_category[code4]	string	*
default_category[enabled]	boolean	*
default_category[groups][]	array of objects (Group)	*
default_category[vats][]	array of objects (Vat)	*
default_category[vats][][id]	integer	*
default_category[vats][][name]	string	*
default_category[vats][][percentage]	float	*
default_category[vats][][enabled]	boolean	*
default_category[vats][][country]	string	*
default_category[vats][][code]		*
default_category[vats][][code2]		*
default_category[vat_fixed]	boolean	*
default_category[types][]	array of integers	*
default_category[resource_required]	boolean	*
default_category[proof_required]	boolean	*
default_tag1	object (Tag)	>=4
default_tag1[id]	integer	*
default_tag1[name]	string	*
default_tag1[explanation]	string	*
default_tag1[enabled]	boolean	*
default_tag1[code]	string	*
default_tag1[code2]	string	*
default_tag1[code3]	string	*
default_tag1[index]	integer	*
default_tag1[groups][]	array of objects (Group)	*
default_tag1[types][]	array of integers	*
default_tag1[parent]	object (Tag)	>=4
default_tag1[manager]	object (User)	*
default_tag1[proof_required]	boolean	*
default_tag2	object (Tag)	>=4
default_tag3	object (Tag)	>=4
default_payment_method	object (PaymentMethod)	*
default_payment_method[users][]	array of integers	*	Get id of related users.
default_payment_method[id]	integer	*
default_payment_method[name]	string	*
default_payment_method[code]	string	*
default_payment_method[code2]	string	*
default_payment_method[enabled]	boolean	*
default_payment_method[type]	integer	*
default_payment_method[issuer]	integer	*
default_payment_method[category_expenditure_cash]	object (Category)	*
default_payment_method[category_expenditure_private]	object (Category)	*
default_payment_method[assign_to]	integer	*
default_payment_method[condition]		*
default_payment_method[number]		*
default_from_location	object (Location)	*
default_from_location[id]	integer	*
default_from_location[query]	string	*
default_from_location[city]	string	*
default_from_location[country]	string	*
default_from_location[address]	string	*
default_from_location[address_number]	string	*
default_from_location[order]	integer	*
default_from_location[latitude]	float	*
default_from_location[longitude]	float	*
default_from_location[label]	string	*
default_to_location	object (Location)	*
uuid	string	*

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations

Get the list of organizations.

Documentation
Sandbox

Documentation

Get the list of organizations.

Filters

Name

Information

user

Requirement	\d+
Description	Filter list by member user

page

Requirement	\d+
Description	Page of items returned
Default	1

limit

Requirement	\d+
Description	Limit number of items returned
Default	100

sort

Requirement	[\w\.]+
Description	List sort attribute
Default	o.name

dir

Requirement	asc\|desc
Description	List sort order
Default	asc

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v4/organizations

Edit an organization entity.

Documentation
Sandbox

Documentation

Edit an organization entity.

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/v4/organizations/{id} unavailable

Delete an organization entity.

Documentation
Sandbox

Documentation

Delete an organization entity.

Requirements

Name	Requirement	Type	Description
id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found
503	Service unavailable

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{id}

Get information on a single organization entity.

Documentation
Sandbox

Documentation

Get information on a single organization entity.

Requirements

Name	Requirement	Type	Description
id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v4/organizations/{id}

Edit an organization entity.

Documentation
Sandbox

Documentation

Edit an organization entity.

Requirements

Name	Requirement	Type	Description
id	\d+

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{id}/corporateidentity

Get information on a single corporate identity.

Documentation
Sandbox

Documentation

Get information on a single corporate identity.

Requirements

Name	Requirement	Type	Description
id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{id}/customfields/{type}

Get the list of customfields.

Documentation
Sandbox

Documentation

Get the list of customfields.

Requirements

Name	Requirement	Type	Description
id	\d+
type	user\|expense\|report\|advance	string

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{id}/disable

Disable or enable an organization entity.

Documentation
Sandbox

Documentation

Disable or enable an organization entity.

Requirements

Name	Requirement	Type	Description
id	\d+

Status Codes

Status Code	Description
204	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{id}/enable

Disable or enable an organization entity.

Documentation
Sandbox

Documentation

Disable or enable an organization entity.

Requirements

Name	Requirement	Type	Description
id	\d+

Status Codes

Status Code	Description
204	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/activities

Get the list of activities.

Documentation
Sandbox

Documentation

Get the list of activities.

Requirements

Name	Requirement	Type	Description
organization_id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v4/organizations/{organization_id}/activities

Edit an activity entity.

Documentation
Sandbox

Documentation

Edit an activity entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+

Return

Parameter	Type	Versions
200 - Successful transaction
name	string	*
maximum	integer	*
futureDays		*
id	integer	*
hash	string	*
groups[]	array of objects (Group)	*
groups[][id]	integer	*
groups[][name]	string	*
groups[][enabled]	boolean	*
groups[][code]	string	*
groups[][creation_date]	DateTime	*
enabled	boolean	*
comments_enabled	boolean	*
comments_required	boolean	*
default	boolean	*
days[]	array of integers	*
holidays_allowed	boolean	*
future_days	integer	*

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/v4/organizations/{organization_id}/activities/{id}

Delete an activity entity.

Documentation
Sandbox

Documentation

Delete an activity entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/activities/{id}

Get information on a single activity entity.

Documentation
Sandbox

Documentation

Get information on a single activity entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Return

Parameter	Type	Versions
200 - Successful transaction
name	string	*
maximum	integer	*
futureDays		*
id	integer	*
hash	string	*
groups[]	array of objects (Group)	*
groups[][id]	integer	*
groups[][name]	string	*
groups[][enabled]	boolean	*
groups[][code]	string	*
groups[][creation_date]	DateTime	*
enabled	boolean	*
comments_enabled	boolean	*
comments_required	boolean	*
default	boolean	*
days[]	array of integers	*
holidays_allowed	boolean	*
future_days	integer	*

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v4/organizations/{organization_id}/activities/{id}

Edit an activity entity.

Documentation
Sandbox

Documentation

Edit an activity entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Return

Parameter	Type	Versions
200 - Successful transaction
name	string	*
maximum	integer	*
futureDays		*
id	integer	*
hash	string	*
groups[]	array of objects (Group)	*
groups[][id]	integer	*
groups[][name]	string	*
groups[][enabled]	boolean	*
groups[][code]	string	*
groups[][creation_date]	DateTime	*
enabled	boolean	*
comments_enabled	boolean	*
comments_required	boolean	*
default	boolean	*
days[]	array of integers	*
holidays_allowed	boolean	*
future_days	integer	*

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/activities/{id}/disable

Disable or enable a activity entity.

Documentation
Sandbox

Documentation

Disable or enable a activity entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Status Codes

Status Code	Description
204	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/activities/{id}/enable

Disable or enable a activity entity.

Documentation
Sandbox

Documentation

Disable or enable a activity entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Status Codes

Status Code	Description
204	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v4/organizations/{organization_id}/advances

Edit an advance entity.

Documentation
Sandbox

Documentation

Edit an advance entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+

Return

Parameter	Type	Versions	Description
200 - Successful transaction
user_id	integer	*	Returns only the corresponding user id.
report_id	integer	*	Returns only the corresponding report id.
organization_id	integer	*	Returns only the corresponding organization id.
field_values	array	*	Get field values array for serialization, without associative keys.
id	integer	*
amount	float	*
value	float	*
currency	string	*
rate	float	*
description	string	*
category	object (Category)	*
category[id]	integer	*
category[name]	string	*
category[explanation]	string	*
category[code]	string	*
category[code2]	string	*
category[code3]	string	*
category[code4]	string	*
category[enabled]	boolean	*
category[groups][]	array of objects (Group)	*
category[groups][][id]	integer	*
category[groups][][name]	string	*
category[groups][][enabled]	boolean	*
category[groups][][code]	string	*
category[groups][][creation_date]	DateTime	*
category[vats][]	array of objects (Vat)	*
category[vats][][id]	integer	*
category[vats][][name]	string	*
category[vats][][percentage]	float	*
category[vats][][enabled]	boolean	*
category[vats][][country]	string	*
category[vats][][code]		*
category[vats][][code2]		*
category[vat_fixed]	boolean	*
category[types][]	array of integers	*
category[resource_required]	boolean	*
category[proof_required]	boolean	*
resource	object (Media)	*
resource[name]	string	*
resource[width]	integer	*
resource[height]	integer	*
resource[creation_date]	DateTime	*
resource[content_type]	string	*
resource[size]	integer	*
resource[id]	integer	*
resource[hash]	string	*
resource[providerReference]		*
resource[providerStatus]		*
date	DateTime	*
user	object (User)	*
user[username]	string	*
user[fullName]	string	*	Get full name.
user[email]	string	>=4	{@inheritdoc}
user[profile_picture]	string	*
user[tenant_id]	integer	*
user[id]	integer	*
user[initials]	string	*
user[first_name]	string	*
user[prefix]	string	*
user[last_name]	string	*
user[groups][]	array of objects (Group)	*
user[groups][][id]	integer	*
user[groups][][name]	string	*
user[groups][][enabled]	boolean	*
user[groups][][code]	string	*
user[groups][][creation_date]	DateTime	*
user[selected_organization]	object (Organization)	*
user[selected_organization][tags]	array	>=4
user[selected_organization][id]	integer	*
user[selected_organization][name]	string	*
user[selected_organization][subdomain]	string	*
user[selected_organization][domain]	string	*
user[selected_organization][address]	string	*
user[selected_organization][zipcode]	string	*
user[selected_organization][city]	string	*
user[selected_organization][locale]	string	*
user[selected_organization][telephone]	string	*
user[selected_organization][email]	string	*
user[selected_organization][holidays][]	array of objects (Holiday)	*	One Organisation has Many Holidays.
user[selected_organization][holidays][][id]	integer	*
user[selected_organization][holidays][][name]	string	*
user[selected_organization][holidays][][holiday_periods][]	array of objects (HolidayPeriod)	*	One Holiday has Many Periods.
user[selected_organization][holidays][][holiday_periods][][id]	integer	*
user[selected_organization][holidays][][holiday_periods][][year]	integer	*
user[selected_organization][holidays][][holiday_periods][][start]	DateTime	*
user[selected_organization][holidays][][holiday_periods][][end]	DateTime	*
user[selected_organization][holidays][][groups][]	array of objects (Group)	*
user[selected_organization][holidays][][enabled]	boolean	*
user[selected_organization][categories][]	array of objects (Category)	*
user[selected_organization][tag_levels][]	array of objects (TagLevel)	>=3
user[selected_organization][tag_levels][][id]	integer	*
user[selected_organization][tag_levels][][index]	integer	*
user[selected_organization][tag_levels][][name]	string	*
user[selected_organization][tag_levels][][required]	boolean	*
user[selected_organization][vats][]	array of objects (Vat)	*
user[selected_organization][vats][][id]	integer	*
user[selected_organization][vats][][name]	string	*
user[selected_organization][vats][][percentage]	float	*
user[selected_organization][vats][][enabled]	boolean	*
user[selected_organization][vats][][country]	string	*
user[selected_organization][vats][][code]		*
user[selected_organization][vats][][code2]		*
user[selected_organization][settings]	object (Settings)	*
user[selected_organization][settings][default_mileage_rate]	float	*
user[selected_organization][settings][rate_per_mile]	float	<=3
user[selected_organization][settings][rate_per_kilometer]	float	<=3
user[selected_organization][settings][id]	integer	*
user[selected_organization][settings][currency]	string	*
user[selected_organization][settings][passcode_required]	boolean	*
user[selected_organization][settings][passcode_length]	integer	*
user[selected_organization][settings][resource_required]	boolean	*
user[selected_organization][settings][description_required]	boolean	*
user[selected_organization][settings][country_enabled]	boolean	*
user[selected_organization][settings][country_required]	boolean	*
user[selected_organization][settings][available_countries][]	array of strings	*
user[selected_organization][settings][category_enabled]	boolean	*
user[selected_organization][settings][category_required]	boolean	*
user[selected_organization][settings][tag_enabled]	boolean	>=4
user[selected_organization][settings][tag_level_check_per_report]	integer	>=4
user[selected_organization][settings][one_manager_per_report]	boolean	>=4.1
user[selected_organization][settings][carbon_copy_field_enabled]	boolean	*
user[selected_organization][settings][payment_method_enabled]	boolean	*
user[selected_organization][settings][payment_method_required]	boolean	*
user[selected_organization][settings][app_input_vat]	boolean	*
user[selected_organization][settings][pdf_one_per_page]	boolean	*
user[selected_organization][settings][mileage_enabled]	boolean	*
user[selected_organization][settings][mileage_distance_fixed]	boolean	*
user[selected_organization][settings][mileage_shortest_distance]	boolean	*
user[selected_organization][settings][settings_modules][]	array of objects (SettingsModule)	*
user[selected_organization][settings][settings_modules][][id]	integer	*
user[selected_organization][settings][settings_modules][][module]	object (Module)	*
user[selected_organization][settings][settings_modules][][module][id]	integer	*
user[selected_organization][settings][settings_modules][][module][key]	string	*
user[selected_organization][settings][settings_modules][][module][name]	string	*
user[selected_organization][settings][settings_modules][][groups][]	array of objects (Group)	*
user[selected_organization][settings][legacy_mode]	boolean	*
user[selected_organization][settings][manager_fixed]	boolean	*
user[selected_organization][settings][user_advances_enabled]	boolean	*
user[selected_organization][settings][advance_currency_enabled]	boolean	*
user[selected_organization][settings][compensation_enabled]	boolean	*
user[selected_organization][settings][track_billable]	boolean	*
user[selected_organization][settings][billable_label]	string	>=4
user[selected_organization][settings][billable_groups][]	array of objects (Group)	>=4
user[selected_organization][settings][currency_fixed]	boolean	*
user[selected_organization][settings][signature_required]	boolean	>=4
user[selected_organization][settings][time_enabled]	boolean	*
user[selected_organization][settings][time_period]	integer	*
user[selected_organization][settings][time_start_of_week]	integer	*
user[selected_organization][settings][help_enabled]	boolean	*
user[selected_organization][settings][smart_report_enabled]	boolean	*
user[selected_organization][settings][smart_report_frequence]	object (Frequence)	*
user[selected_organization][settings][smart_report_frequence][id]	integer	*
user[selected_organization][settings][smart_report_frequence][period]	integer	*
user[selected_organization][settings][smart_report_frequence][day]	integer	*
user[selected_organization][settings][smart_report_frequence][not_before]	DateTime	*
user[selected_organization][settings][smart_report_frequence][not_after]	DateTime	*
user[selected_organization][settings][report_default_name]	string	*
user[selected_organization][settings][trip_default_name]	string	*
user[selected_organization][settings][default_advance_category]	object (Category)	*
user[selected_organization][settings][advance_resource_required]	boolean	*
user[selected_organization][settings][default_region]	object (Place)	*
user[selected_organization][settings][default_region][label]	string	*
user[selected_organization][settings][default_region][id]	integer	*
user[selected_organization][settings][default_region][country]	string	*
user[selected_organization][settings][default_region][city]	string	*
user[selected_organization][settings][default_region][google_id]	string	*
user[selected_organization][settings][default_region][type]	string	*
user[selected_organization][settings][default_region][country_code]	string	*
user[selected_organization][settings][default_region][timezone]	string	*
user[selected_organization][settings][default_region][latitude]	float	*
user[selected_organization][settings][default_region][longitude]	float	*
user[selected_organization][settings][default_region][whitelisted]	boolean	*
user[selected_organization][settings][one_payment_method_per_report]	boolean	>=4.1
user[selected_organization][settings][max_expenses_per_report]	integer	*
user[selected_organization][settings][reject_comment_required]	boolean	*
user[selected_organization][settings][passcodeLength]		*
user[selected_organization][settings][maxExpensesPerReport]		*
user[selected_organization][disabled]	boolean	*
user[selected_organization][adp_account]	object (AdpAccount)	*
user[selected_organization][adp_account][id]	integer	*
user[selected_organization][payment_methods][]	array of objects (PaymentMethod)	*
user[selected_organization][payment_methods][][users][]	array of integers	*	Get id of related users.
user[selected_organization][payment_methods][][id]	integer	*
user[selected_organization][payment_methods][][name]	string	*
user[selected_organization][payment_methods][][code]	string	*
user[selected_organization][payment_methods][][code2]	string	*
user[selected_organization][payment_methods][][enabled]	boolean	*
user[selected_organization][payment_methods][][type]	integer	*
user[selected_organization][payment_methods][][issuer]	integer	*
user[selected_organization][payment_methods][][category_expenditure_cash]	object (Category)	*
user[selected_organization][payment_methods][][category_expenditure_private]	object (Category)	*
user[selected_organization][payment_methods][][assign_to]	integer	*
user[selected_organization][payment_methods][][condition]		*
user[selected_organization][payment_methods][][number]		*
user[selected_organization][export_formats][]	array of objects (ExportFormat)	*	ArrayCollection $exportFormats.
user[selected_organization][export_formats][][id]	integer	*
user[selected_organization][export_formats][][type]	string	*
user[selected_organization][export_formats][][name]	string	*
user[selected_organization][export_formats][][file]		*
user[selected_organization][compensation_types][]	array of objects (CompensationType)	*
user[selected_organization][compensation_types][][id]	integer	*
user[selected_organization][compensation_types][][type]	integer	*
user[selected_organization][compensation_types][][name]	string	*
user[selected_organization][compensation_types][][min]	integer	*
user[selected_organization][compensation_types][][currency]	string	*
user[selected_organization][compensation_types][][max]	integer	*
user[selected_organization][compensation_types][][step]	float	*
user[selected_organization][compensation_types][][enabled]	boolean	*
user[selected_organization][compensation_types][][unit]	integer	*
user[selected_organization][compensation_types][][rate]	float	*
user[selected_organization][compensation_types][][rate_fixed]	boolean	*
user[selected_organization][compensation_types][][vat]	object (Vat)	*
user[selected_organization][compensation_types][][vat_fixed]	boolean	*
user[selected_organization][compensation_types][][category_enabled]	boolean	*
user[selected_organization][compensation_types][][category_required]	boolean	*
user[selected_organization][compensation_types][][category_fixed]	boolean	*
user[selected_organization][compensation_types][][category]	object (Category)	*
user[selected_organization][compensation_types][][tag_enabled]	boolean	>=4
user[selected_organization][compensation_types][][tag_fixed]	boolean	>=4
user[selected_organization][compensation_types][][tag1]	object (Tag)	>=4
user[selected_organization][compensation_types][][tag1][id]	integer	*
user[selected_organization][compensation_types][][tag1][name]	string	*
user[selected_organization][compensation_types][][tag1][explanation]	string	*
user[selected_organization][compensation_types][][tag1][enabled]	boolean	*
user[selected_organization][compensation_types][][tag1][code]	string	*
user[selected_organization][compensation_types][][tag1][code2]	string	*
user[selected_organization][compensation_types][][tag1][code3]	string	*
user[selected_organization][compensation_types][][tag1][index]	integer	*
user[selected_organization][compensation_types][][tag1][groups][]	array of objects (Group)	*
user[selected_organization][compensation_types][][tag1][types][]	array of integers	*
user[selected_organization][compensation_types][][tag1][parent]	object (Tag)	>=4
user[selected_organization][compensation_types][][tag1][manager]	object (User)	*
user[selected_organization][compensation_types][][tag1][proof_required]	boolean	*
user[selected_organization][compensation_types][][tag2]	object (Tag)	>=4
user[selected_organization][compensation_types][][country]	string	*
user[selected_organization][compensation_types][][country_fixed]	boolean	*
user[selected_organization][compensation_types][][files_enabled]	boolean	*
user[selected_organization][compensation_types][][files_required]	boolean	*
user[selected_organization][compensation_types][][description_enabled]	boolean	*
user[selected_organization][compensation_types][][description_required]	boolean	*
user[selected_organization][compensation_types][][groups][]	array of objects (Group)	*
user[selected_organization][compensation_types][][code]		*
user[selected_organization][mileage_rates][]	array of objects (MileageRate)	*
user[selected_organization][mileage_rates][][mode_of_transport]	string	*
user[selected_organization][mileage_rates][][id]	integer	*
user[selected_organization][mileage_rates][][name]	string	*
user[selected_organization][mileage_rates][][unit]	integer	*
user[selected_organization][mileage_rates][][rate]	float	*
user[selected_organization][mileage_rates][][currency]	string	*
user[selected_organization][mileage_rates][][untaxed]	float	*
user[selected_organization][mileage_rates][][category]	object (Category)	*
user[selected_organization][mileage_rates][][groups][]	array of objects (Group)	*
user[selected_organization][mileage_rates][][enabled]	boolean	*
user[selected_organization][corporate_identity]	object (CorporateIdentity)	*
user[selected_organization][corporate_identity][id]	integer	*
user[selected_organization][corporate_identity][primary_color]	string	*
user[selected_organization][corporate_identity][logo_color]	string	*
user[selected_organization][corporate_identity][app_icon]	string	*
user[selected_organization][corporate_identity][app_main_tint_color]	string	*
user[selected_organization][corporate_identity][app_secondary_tint_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_border_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_top_color]	string	*
user[selected_organization][corporate_identity][app_expense_button_text_color]	string	*
user[selected_organization][corporate_identity][app_table_view_background_color]	string	*
user[selected_organization][corporate_identity][reply_to]	string	*
user[selected_organization][corporate_identity][from_name]	string	*
user[selected_organization][corporate_identity][sender_name]	string	*
user[selected_organization][corporate_identity][regulations]	string	*
user[selected_organization][corporate_identity][translations][]	array of objects (Translation)	*
user[selected_organization][corporate_identity][translations][][id]	integer	*
user[selected_organization][corporate_identity][translations][][key]	string	*
user[selected_organization][corporate_identity][translations][][locale]	string	*
user[selected_organization][corporate_identity][translations][][translation]	string	*
user[selected_organization][corporate_identity][translations][][identity]	object (CorporateIdentity)	*
user[selected_organization][corporate_identity][submitter_signature]	string	*
user[selected_organization][corporate_identity][approver_signature]	string	*
user[selected_organization][activities][]	array of objects (Activity)	*
user[selected_organization][activities][][id]	integer	*
user[selected_organization][activities][][hash]	string	*
user[selected_organization][activities][][name]	string	*
user[selected_organization][activities][][groups][]	array of objects (Group)	*
user[selected_organization][activities][][enabled]	boolean	*
user[selected_organization][activities][][comments_enabled]	boolean	*
user[selected_organization][activities][][comments_required]	boolean	*
user[selected_organization][activities][][default]	boolean	*
user[selected_organization][activities][][days][]	array of integers	*
user[selected_organization][activities][][holidays_allowed]	boolean	*
user[selected_organization][activities][][maximum]	integer	*
user[selected_organization][activities][][future_days]	integer	*
user[selected_organization][activities][][futureDays]		*
user[selected_organization][address2]		*
user[selected_organization][country]		*
user[selected_organization][taxNumber]		*
user[selected_organization][iban]		*
user[code]	string	*
user[submits_to]	object (User)	*
user[approves_to]	object (User)	*
user[locale]	string	*
user[budget]	float	>=4
user[field_values][]	array of objects (CustomFieldValue)	*
user[field_values][][field_id]	integer	*
user[field_values][][id]	integer	*
user[field_values][][field]	object (CustomField)	*
user[field_values][][field][category_id]	integer	*	This is here for backwards compatibility in the app. Please don't use it.
user[field_values][][field][category_ids][]	array of integers	*
user[field_values][][field][parent_id]	integer	*
user[field_values][][field][parent_option_id]	integer	*
user[field_values][][field][id]	integer	*
user[field_values][][field][name]	string	*
user[field_values][][field][type]	integer	*
user[field_values][][field][order]	string	*
user[field_values][][field][placeholder]	string	*
user[field_values][][field][required]	boolean	*
user[field_values][][field][default_value]	string	*
user[field_values][][field][default_option]	object (CustomFieldOption)	*
user[field_values][][field][default_option][parent_id]	integer	*	Get parent id.
user[field_values][][field][default_option][id]	integer	*
user[field_values][][field][default_option][value]	string	*
user[field_values][][field][default_option][name]	string	*
user[field_values][][field][default_option][text1]	string	*
user[field_values][][field][default_option][text2]	string	*
user[field_values][][field][default_option][enabled]	boolean	*
user[field_values][][field][default_option][groups][]	array of objects (Group)	*
user[field_values][][field][options][]	array of objects (CustomFieldOption)	*
user[field_values][][field][user_editable]	boolean	*	@ORM\Column(name="userEditable", type="boolean")
user[field_values][][field][header_field]	boolean	*	@ORM\Column(name="headerField", type="boolean")
user[field_values][][field][regex]	string	*	@ORM\Column(type="text", nullable=true)
user[field_values][][field][enabled]	boolean	*	@ORM\Column(type="boolean")
user[field_values][][field][key]	string	*
user[field_values][][field][allow_user_default]	boolean	*
user[field_values][][field][sort]		*
user[field_values][][field][defaultValue]		*
user[field_values][][option]	object (CustomFieldOption)	*
user[field_values][][option][parent_id]	integer	*	Get parent id.
user[field_values][][option][id]	integer	*
user[field_values][][option][value]	string	*
user[field_values][][option][name]	string	*
user[field_values][][option][text1]	string	*
user[field_values][][option][text2]	string	*
user[field_values][][option][enabled]	boolean	*
user[field_values][][option][groups][]	array of objects (Group)	*
user[field_values][][value]	string	*
user[default_currency]	string	*
user[default_country]	string	*
user[default_category]	object (Category)	*
user[default_tag1]	object (Tag)	>=4
user[default_tag1][id]	integer	*
user[default_tag1][name]	string	*
user[default_tag1][explanation]	string	*
user[default_tag1][enabled]	boolean	*
user[default_tag1][code]	string	*
user[default_tag1][code2]	string	*
user[default_tag1][code3]	string	*
user[default_tag1][index]	integer	*
user[default_tag1][groups][]	array of objects (Group)	*
user[default_tag1][types][]	array of integers	*
user[default_tag1][parent]	object (Tag)	>=4
user[default_tag1][manager]	object (User)	*
user[default_tag1][proof_required]	boolean	*
user[default_tag2]	object (Tag)	>=4
user[default_tag3]	object (Tag)	>=4
user[default_payment_method]	object (PaymentMethod)	*
user[default_payment_method][users][]	array of integers	*	Get id of related users.
user[default_payment_method][id]	integer	*
user[default_payment_method][name]	string	*
user[default_payment_method][code]	string	*
user[default_payment_method][code2]	string	*
user[default_payment_method][enabled]	boolean	*
user[default_payment_method][type]	integer	*
user[default_payment_method][issuer]	integer	*
user[default_payment_method][category_expenditure_cash]	object (Category)	*
user[default_payment_method][category_expenditure_private]	object (Category)	*
user[default_payment_method][assign_to]	integer	*
user[default_payment_method][condition]		*
user[default_payment_method][number]		*
user[default_from_location]	object (Location)	*
user[default_from_location][id]	integer	*
user[default_from_location][query]	string	*
user[default_from_location][city]	string	*
user[default_from_location][country]	string	*
user[default_from_location][address]	string	*
user[default_from_location][address_number]	string	*
user[default_from_location][order]	integer	*
user[default_from_location][latitude]	float	*
user[default_from_location][longitude]	float	*
user[default_from_location][label]	string	*
user[default_to_location]	object (Location)	*
user[uuid]	string	*
user[firstName]		*
user[lastName]		*
user[plainPassword]		*
user[registrationCode]		*
user[code2]		*
user[accountNumber]		*
user[emailAlternative]		*
author	object (User)	*
hash	string	*

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/v4/organizations/{organization_id}/advances/{id}

Delete an advance entity.

Documentation
Sandbox

Documentation

Delete an advance entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/advances/{id}

Get information on a single advance entity.

Documentation
Sandbox

Documentation

Get information on a single advance entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Return

Parameter	Type	Versions	Description
200 - Successful transaction
user_id	integer	*	Returns only the corresponding user id.
report_id	integer	*	Returns only the corresponding report id.
organization_id	integer	*	Returns only the corresponding organization id.
field_values	array	*	Get field values array for serialization, without associative keys.
id	integer	*
amount	float	*
value	float	*
currency	string	*
rate	float	*
description	string	*
category	object (Category)	*
category[id]	integer	*
category[name]	string	*
category[explanation]	string	*
category[code]	string	*
category[code2]	string	*
category[code3]	string	*
category[code4]	string	*
category[enabled]	boolean	*
category[groups][]	array of objects (Group)	*
category[groups][][id]	integer	*
category[groups][][name]	string	*
category[groups][][enabled]	boolean	*
category[groups][][code]	string	*
category[groups][][creation_date]	DateTime	*
category[vats][]	array of objects (Vat)	*
category[vats][][id]	integer	*
category[vats][][name]	string	*
category[vats][][percentage]	float	*
category[vats][][enabled]	boolean	*
category[vats][][country]	string	*
category[vats][][code]		*
category[vats][][code2]		*
category[vat_fixed]	boolean	*
category[types][]	array of integers	*
category[resource_required]	boolean	*
category[proof_required]	boolean	*
resource	object (Media)	*
resource[name]	string	*
resource[width]	integer	*
resource[height]	integer	*
resource[creation_date]	DateTime	*
resource[content_type]	string	*
resource[size]	integer	*
resource[id]	integer	*
resource[hash]	string	*
resource[providerReference]		*
resource[providerStatus]		*
date	DateTime	*
user	object (User)	*
user[username]	string	*
user[fullName]	string	*	Get full name.
user[email]	string	>=4	{@inheritdoc}
user[profile_picture]	string	*
user[tenant_id]	integer	*
user[id]	integer	*
user[initials]	string	*
user[first_name]	string	*
user[prefix]	string	*
user[last_name]	string	*
user[groups][]	array of objects (Group)	*
user[groups][][id]	integer	*
user[groups][][name]	string	*
user[groups][][enabled]	boolean	*
user[groups][][code]	string	*
user[groups][][creation_date]	DateTime	*
user[selected_organization]	object (Organization)	*
user[selected_organization][tags]	array	>=4
user[selected_organization][id]	integer	*
user[selected_organization][name]	string	*
user[selected_organization][subdomain]	string	*
user[selected_organization][domain]	string	*
user[selected_organization][address]	string	*
user[selected_organization][zipcode]	string	*
user[selected_organization][city]	string	*
user[selected_organization][locale]	string	*
user[selected_organization][telephone]	string	*
user[selected_organization][email]	string	*
user[selected_organization][holidays][]	array of objects (Holiday)	*	One Organisation has Many Holidays.
user[selected_organization][holidays][][id]	integer	*
user[selected_organization][holidays][][name]	string	*
user[selected_organization][holidays][][holiday_periods][]	array of objects (HolidayPeriod)	*	One Holiday has Many Periods.
user[selected_organization][holidays][][holiday_periods][][id]	integer	*
user[selected_organization][holidays][][holiday_periods][][year]	integer	*
user[selected_organization][holidays][][holiday_periods][][start]	DateTime	*
user[selected_organization][holidays][][holiday_periods][][end]	DateTime	*
user[selected_organization][holidays][][groups][]	array of objects (Group)	*
user[selected_organization][holidays][][enabled]	boolean	*
user[selected_organization][categories][]	array of objects (Category)	*
user[selected_organization][tag_levels][]	array of objects (TagLevel)	>=3
user[selected_organization][tag_levels][][id]	integer	*
user[selected_organization][tag_levels][][index]	integer	*
user[selected_organization][tag_levels][][name]	string	*
user[selected_organization][tag_levels][][required]	boolean	*
user[selected_organization][vats][]	array of objects (Vat)	*
user[selected_organization][vats][][id]	integer	*
user[selected_organization][vats][][name]	string	*
user[selected_organization][vats][][percentage]	float	*
user[selected_organization][vats][][enabled]	boolean	*
user[selected_organization][vats][][country]	string	*
user[selected_organization][vats][][code]		*
user[selected_organization][vats][][code2]		*
user[selected_organization][settings]	object (Settings)	*
user[selected_organization][settings][default_mileage_rate]	float	*
user[selected_organization][settings][rate_per_mile]	float	<=3
user[selected_organization][settings][rate_per_kilometer]	float	<=3
user[selected_organization][settings][id]	integer	*
user[selected_organization][settings][currency]	string	*
user[selected_organization][settings][passcode_required]	boolean	*
user[selected_organization][settings][passcode_length]	integer	*
user[selected_organization][settings][resource_required]	boolean	*
user[selected_organization][settings][description_required]	boolean	*
user[selected_organization][settings][country_enabled]	boolean	*
user[selected_organization][settings][country_required]	boolean	*
user[selected_organization][settings][available_countries][]	array of strings	*
user[selected_organization][settings][category_enabled]	boolean	*
user[selected_organization][settings][category_required]	boolean	*
user[selected_organization][settings][tag_enabled]	boolean	>=4
user[selected_organization][settings][tag_level_check_per_report]	integer	>=4
user[selected_organization][settings][one_manager_per_report]	boolean	>=4.1
user[selected_organization][settings][carbon_copy_field_enabled]	boolean	*
user[selected_organization][settings][payment_method_enabled]	boolean	*
user[selected_organization][settings][payment_method_required]	boolean	*
user[selected_organization][settings][app_input_vat]	boolean	*
user[selected_organization][settings][pdf_one_per_page]	boolean	*
user[selected_organization][settings][mileage_enabled]	boolean	*
user[selected_organization][settings][mileage_distance_fixed]	boolean	*
user[selected_organization][settings][mileage_shortest_distance]	boolean	*
user[selected_organization][settings][settings_modules][]	array of objects (SettingsModule)	*
user[selected_organization][settings][settings_modules][][id]	integer	*
user[selected_organization][settings][settings_modules][][module]	object (Module)	*
user[selected_organization][settings][settings_modules][][module][id]	integer	*
user[selected_organization][settings][settings_modules][][module][key]	string	*
user[selected_organization][settings][settings_modules][][module][name]	string	*
user[selected_organization][settings][settings_modules][][groups][]	array of objects (Group)	*
user[selected_organization][settings][legacy_mode]	boolean	*
user[selected_organization][settings][manager_fixed]	boolean	*
user[selected_organization][settings][user_advances_enabled]	boolean	*
user[selected_organization][settings][advance_currency_enabled]	boolean	*
user[selected_organization][settings][compensation_enabled]	boolean	*
user[selected_organization][settings][track_billable]	boolean	*
user[selected_organization][settings][billable_label]	string	>=4
user[selected_organization][settings][billable_groups][]	array of objects (Group)	>=4
user[selected_organization][settings][currency_fixed]	boolean	*
user[selected_organization][settings][signature_required]	boolean	>=4
user[selected_organization][settings][time_enabled]	boolean	*
user[selected_organization][settings][time_period]	integer	*
user[selected_organization][settings][time_start_of_week]	integer	*
user[selected_organization][settings][help_enabled]	boolean	*
user[selected_organization][settings][smart_report_enabled]	boolean	*
user[selected_organization][settings][smart_report_frequence]	object (Frequence)	*
user[selected_organization][settings][smart_report_frequence][id]	integer	*
user[selected_organization][settings][smart_report_frequence][period]	integer	*
user[selected_organization][settings][smart_report_frequence][day]	integer	*
user[selected_organization][settings][smart_report_frequence][not_before]	DateTime	*
user[selected_organization][settings][smart_report_frequence][not_after]	DateTime	*
user[selected_organization][settings][report_default_name]	string	*
user[selected_organization][settings][trip_default_name]	string	*
user[selected_organization][settings][default_advance_category]	object (Category)	*
user[selected_organization][settings][advance_resource_required]	boolean	*
user[selected_organization][settings][default_region]	object (Place)	*
user[selected_organization][settings][default_region][label]	string	*
user[selected_organization][settings][default_region][id]	integer	*
user[selected_organization][settings][default_region][country]	string	*
user[selected_organization][settings][default_region][city]	string	*
user[selected_organization][settings][default_region][google_id]	string	*
user[selected_organization][settings][default_region][type]	string	*
user[selected_organization][settings][default_region][country_code]	string	*
user[selected_organization][settings][default_region][timezone]	string	*
user[selected_organization][settings][default_region][latitude]	float	*
user[selected_organization][settings][default_region][longitude]	float	*
user[selected_organization][settings][default_region][whitelisted]	boolean	*
user[selected_organization][settings][one_payment_method_per_report]	boolean	>=4.1
user[selected_organization][settings][max_expenses_per_report]	integer	*
user[selected_organization][settings][reject_comment_required]	boolean	*
user[selected_organization][settings][passcodeLength]		*
user[selected_organization][settings][maxExpensesPerReport]		*
user[selected_organization][disabled]	boolean	*
user[selected_organization][adp_account]	object (AdpAccount)	*
user[selected_organization][adp_account][id]	integer	*
user[selected_organization][payment_methods][]	array of objects (PaymentMethod)	*
user[selected_organization][payment_methods][][users][]	array of integers	*	Get id of related users.
user[selected_organization][payment_methods][][id]	integer	*
user[selected_organization][payment_methods][][name]	string	*
user[selected_organization][payment_methods][][code]	string	*
user[selected_organization][payment_methods][][code2]	string	*
user[selected_organization][payment_methods][][enabled]	boolean	*
user[selected_organization][payment_methods][][type]	integer	*
user[selected_organization][payment_methods][][issuer]	integer	*
user[selected_organization][payment_methods][][category_expenditure_cash]	object (Category)	*
user[selected_organization][payment_methods][][category_expenditure_private]	object (Category)	*
user[selected_organization][payment_methods][][assign_to]	integer	*
user[selected_organization][payment_methods][][condition]		*
user[selected_organization][payment_methods][][number]		*
user[selected_organization][export_formats][]	array of objects (ExportFormat)	*	ArrayCollection $exportFormats.
user[selected_organization][export_formats][][id]	integer	*
user[selected_organization][export_formats][][type]	string	*
user[selected_organization][export_formats][][name]	string	*
user[selected_organization][export_formats][][file]		*
user[selected_organization][compensation_types][]	array of objects (CompensationType)	*
user[selected_organization][compensation_types][][id]	integer	*
user[selected_organization][compensation_types][][type]	integer	*
user[selected_organization][compensation_types][][name]	string	*
user[selected_organization][compensation_types][][min]	integer	*
user[selected_organization][compensation_types][][currency]	string	*
user[selected_organization][compensation_types][][max]	integer	*
user[selected_organization][compensation_types][][step]	float	*
user[selected_organization][compensation_types][][enabled]	boolean	*
user[selected_organization][compensation_types][][unit]	integer	*
user[selected_organization][compensation_types][][rate]	float	*
user[selected_organization][compensation_types][][rate_fixed]	boolean	*
user[selected_organization][compensation_types][][vat]	object (Vat)	*
user[selected_organization][compensation_types][][vat_fixed]	boolean	*
user[selected_organization][compensation_types][][category_enabled]	boolean	*
user[selected_organization][compensation_types][][category_required]	boolean	*
user[selected_organization][compensation_types][][category_fixed]	boolean	*
user[selected_organization][compensation_types][][category]	object (Category)	*
user[selected_organization][compensation_types][][tag_enabled]	boolean	>=4
user[selected_organization][compensation_types][][tag_fixed]	boolean	>=4
user[selected_organization][compensation_types][][tag1]	object (Tag)	>=4
user[selected_organization][compensation_types][][tag1][id]	integer	*
user[selected_organization][compensation_types][][tag1][name]	string	*
user[selected_organization][compensation_types][][tag1][explanation]	string	*
user[selected_organization][compensation_types][][tag1][enabled]	boolean	*
user[selected_organization][compensation_types][][tag1][code]	string	*
user[selected_organization][compensation_types][][tag1][code2]	string	*
user[selected_organization][compensation_types][][tag1][code3]	string	*
user[selected_organization][compensation_types][][tag1][index]	integer	*
user[selected_organization][compensation_types][][tag1][groups][]	array of objects (Group)	*
user[selected_organization][compensation_types][][tag1][types][]	array of integers	*
user[selected_organization][compensation_types][][tag1][parent]	object (Tag)	>=4
user[selected_organization][compensation_types][][tag1][manager]	object (User)	*
user[selected_organization][compensation_types][][tag1][proof_required]	boolean	*
user[selected_organization][compensation_types][][tag2]	object (Tag)	>=4
user[selected_organization][compensation_types][][country]	string	*
user[selected_organization][compensation_types][][country_fixed]	boolean	*
user[selected_organization][compensation_types][][files_enabled]	boolean	*
user[selected_organization][compensation_types][][files_required]	boolean	*
user[selected_organization][compensation_types][][description_enabled]	boolean	*
user[selected_organization][compensation_types][][description_required]	boolean	*
user[selected_organization][compensation_types][][groups][]	array of objects (Group)	*
user[selected_organization][compensation_types][][code]		*
user[selected_organization][mileage_rates][]	array of objects (MileageRate)	*
user[selected_organization][mileage_rates][][mode_of_transport]	string	*
user[selected_organization][mileage_rates][][id]	integer	*
user[selected_organization][mileage_rates][][name]	string	*
user[selected_organization][mileage_rates][][unit]	integer	*
user[selected_organization][mileage_rates][][rate]	float	*
user[selected_organization][mileage_rates][][currency]	string	*
user[selected_organization][mileage_rates][][untaxed]	float	*
user[selected_organization][mileage_rates][][category]	object (Category)	*
user[selected_organization][mileage_rates][][groups][]	array of objects (Group)	*
user[selected_organization][mileage_rates][][enabled]	boolean	*
user[selected_organization][corporate_identity]	object (CorporateIdentity)	*
user[selected_organization][corporate_identity][id]	integer	*
user[selected_organization][corporate_identity][primary_color]	string	*
user[selected_organization][corporate_identity][logo_color]	string	*
user[selected_organization][corporate_identity][app_icon]	string	*
user[selected_organization][corporate_identity][app_main_tint_color]	string	*
user[selected_organization][corporate_identity][app_secondary_tint_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_border_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_top_color]	string	*
user[selected_organization][corporate_identity][app_expense_button_text_color]	string	*
user[selected_organization][corporate_identity][app_table_view_background_color]	string	*
user[selected_organization][corporate_identity][reply_to]	string	*
user[selected_organization][corporate_identity][from_name]	string	*
user[selected_organization][corporate_identity][sender_name]	string	*
user[selected_organization][corporate_identity][regulations]	string	*
user[selected_organization][corporate_identity][translations][]	array of objects (Translation)	*
user[selected_organization][corporate_identity][translations][][id]	integer	*
user[selected_organization][corporate_identity][translations][][key]	string	*
user[selected_organization][corporate_identity][translations][][locale]	string	*
user[selected_organization][corporate_identity][translations][][translation]	string	*
user[selected_organization][corporate_identity][translations][][identity]	object (CorporateIdentity)	*
user[selected_organization][corporate_identity][submitter_signature]	string	*
user[selected_organization][corporate_identity][approver_signature]	string	*
user[selected_organization][activities][]	array of objects (Activity)	*
user[selected_organization][activities][][id]	integer	*
user[selected_organization][activities][][hash]	string	*
user[selected_organization][activities][][name]	string	*
user[selected_organization][activities][][groups][]	array of objects (Group)	*
user[selected_organization][activities][][enabled]	boolean	*
user[selected_organization][activities][][comments_enabled]	boolean	*
user[selected_organization][activities][][comments_required]	boolean	*
user[selected_organization][activities][][default]	boolean	*
user[selected_organization][activities][][days][]	array of integers	*
user[selected_organization][activities][][holidays_allowed]	boolean	*
user[selected_organization][activities][][maximum]	integer	*
user[selected_organization][activities][][future_days]	integer	*
user[selected_organization][activities][][futureDays]		*
user[selected_organization][address2]		*
user[selected_organization][country]		*
user[selected_organization][taxNumber]		*
user[selected_organization][iban]		*
user[code]	string	*
user[submits_to]	object (User)	*
user[approves_to]	object (User)	*
user[locale]	string	*
user[budget]	float	>=4
user[field_values][]	array of objects (CustomFieldValue)	*
user[field_values][][field_id]	integer	*
user[field_values][][id]	integer	*
user[field_values][][field]	object (CustomField)	*
user[field_values][][field][category_id]	integer	*	This is here for backwards compatibility in the app. Please don't use it.
user[field_values][][field][category_ids][]	array of integers	*
user[field_values][][field][parent_id]	integer	*
user[field_values][][field][parent_option_id]	integer	*
user[field_values][][field][id]	integer	*
user[field_values][][field][name]	string	*
user[field_values][][field][type]	integer	*
user[field_values][][field][order]	string	*
user[field_values][][field][placeholder]	string	*
user[field_values][][field][required]	boolean	*
user[field_values][][field][default_value]	string	*
user[field_values][][field][default_option]	object (CustomFieldOption)	*
user[field_values][][field][default_option][parent_id]	integer	*	Get parent id.
user[field_values][][field][default_option][id]	integer	*
user[field_values][][field][default_option][value]	string	*
user[field_values][][field][default_option][name]	string	*
user[field_values][][field][default_option][text1]	string	*
user[field_values][][field][default_option][text2]	string	*
user[field_values][][field][default_option][enabled]	boolean	*
user[field_values][][field][default_option][groups][]	array of objects (Group)	*
user[field_values][][field][options][]	array of objects (CustomFieldOption)	*
user[field_values][][field][user_editable]	boolean	*	@ORM\Column(name="userEditable", type="boolean")
user[field_values][][field][header_field]	boolean	*	@ORM\Column(name="headerField", type="boolean")
user[field_values][][field][regex]	string	*	@ORM\Column(type="text", nullable=true)
user[field_values][][field][enabled]	boolean	*	@ORM\Column(type="boolean")
user[field_values][][field][key]	string	*
user[field_values][][field][allow_user_default]	boolean	*
user[field_values][][field][sort]		*
user[field_values][][field][defaultValue]		*
user[field_values][][option]	object (CustomFieldOption)	*
user[field_values][][option][parent_id]	integer	*	Get parent id.
user[field_values][][option][id]	integer	*
user[field_values][][option][value]	string	*
user[field_values][][option][name]	string	*
user[field_values][][option][text1]	string	*
user[field_values][][option][text2]	string	*
user[field_values][][option][enabled]	boolean	*
user[field_values][][option][groups][]	array of objects (Group)	*
user[field_values][][value]	string	*
user[default_currency]	string	*
user[default_country]	string	*
user[default_category]	object (Category)	*
user[default_tag1]	object (Tag)	>=4
user[default_tag1][id]	integer	*
user[default_tag1][name]	string	*
user[default_tag1][explanation]	string	*
user[default_tag1][enabled]	boolean	*
user[default_tag1][code]	string	*
user[default_tag1][code2]	string	*
user[default_tag1][code3]	string	*
user[default_tag1][index]	integer	*
user[default_tag1][groups][]	array of objects (Group)	*
user[default_tag1][types][]	array of integers	*
user[default_tag1][parent]	object (Tag)	>=4
user[default_tag1][manager]	object (User)	*
user[default_tag1][proof_required]	boolean	*
user[default_tag2]	object (Tag)	>=4
user[default_tag3]	object (Tag)	>=4
user[default_payment_method]	object (PaymentMethod)	*
user[default_payment_method][users][]	array of integers	*	Get id of related users.
user[default_payment_method][id]	integer	*
user[default_payment_method][name]	string	*
user[default_payment_method][code]	string	*
user[default_payment_method][code2]	string	*
user[default_payment_method][enabled]	boolean	*
user[default_payment_method][type]	integer	*
user[default_payment_method][issuer]	integer	*
user[default_payment_method][category_expenditure_cash]	object (Category)	*
user[default_payment_method][category_expenditure_private]	object (Category)	*
user[default_payment_method][assign_to]	integer	*
user[default_payment_method][condition]		*
user[default_payment_method][number]		*
user[default_from_location]	object (Location)	*
user[default_from_location][id]	integer	*
user[default_from_location][query]	string	*
user[default_from_location][city]	string	*
user[default_from_location][country]	string	*
user[default_from_location][address]	string	*
user[default_from_location][address_number]	string	*
user[default_from_location][order]	integer	*
user[default_from_location][latitude]	float	*
user[default_from_location][longitude]	float	*
user[default_from_location][label]	string	*
user[default_to_location]	object (Location)	*
user[uuid]	string	*
user[firstName]		*
user[lastName]		*
user[plainPassword]		*
user[registrationCode]		*
user[code2]		*
user[accountNumber]		*
user[emailAlternative]		*
author	object (User)	*
hash	string	*

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v4/organizations/{organization_id}/advances/{id}

Edit an advance entity.

Documentation
Sandbox

Documentation

Edit an advance entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+	null

Return

Parameter	Type	Versions	Description
200 - Successful transaction
user_id	integer	*	Returns only the corresponding user id.
report_id	integer	*	Returns only the corresponding report id.
organization_id	integer	*	Returns only the corresponding organization id.
field_values	array	*	Get field values array for serialization, without associative keys.
id	integer	*
amount	float	*
value	float	*
currency	string	*
rate	float	*
description	string	*
category	object (Category)	*
category[id]	integer	*
category[name]	string	*
category[explanation]	string	*
category[code]	string	*
category[code2]	string	*
category[code3]	string	*
category[code4]	string	*
category[enabled]	boolean	*
category[groups][]	array of objects (Group)	*
category[groups][][id]	integer	*
category[groups][][name]	string	*
category[groups][][enabled]	boolean	*
category[groups][][code]	string	*
category[groups][][creation_date]	DateTime	*
category[vats][]	array of objects (Vat)	*
category[vats][][id]	integer	*
category[vats][][name]	string	*
category[vats][][percentage]	float	*
category[vats][][enabled]	boolean	*
category[vats][][country]	string	*
category[vats][][code]		*
category[vats][][code2]		*
category[vat_fixed]	boolean	*
category[types][]	array of integers	*
category[resource_required]	boolean	*
category[proof_required]	boolean	*
resource	object (Media)	*
resource[name]	string	*
resource[width]	integer	*
resource[height]	integer	*
resource[creation_date]	DateTime	*
resource[content_type]	string	*
resource[size]	integer	*
resource[id]	integer	*
resource[hash]	string	*
resource[providerReference]		*
resource[providerStatus]		*
date	DateTime	*
user	object (User)	*
user[username]	string	*
user[fullName]	string	*	Get full name.
user[email]	string	>=4	{@inheritdoc}
user[profile_picture]	string	*
user[tenant_id]	integer	*
user[id]	integer	*
user[initials]	string	*
user[first_name]	string	*
user[prefix]	string	*
user[last_name]	string	*
user[groups][]	array of objects (Group)	*
user[groups][][id]	integer	*
user[groups][][name]	string	*
user[groups][][enabled]	boolean	*
user[groups][][code]	string	*
user[groups][][creation_date]	DateTime	*
user[selected_organization]	object (Organization)	*
user[selected_organization][tags]	array	>=4
user[selected_organization][id]	integer	*
user[selected_organization][name]	string	*
user[selected_organization][subdomain]	string	*
user[selected_organization][domain]	string	*
user[selected_organization][address]	string	*
user[selected_organization][zipcode]	string	*
user[selected_organization][city]	string	*
user[selected_organization][locale]	string	*
user[selected_organization][telephone]	string	*
user[selected_organization][email]	string	*
user[selected_organization][holidays][]	array of objects (Holiday)	*	One Organisation has Many Holidays.
user[selected_organization][holidays][][id]	integer	*
user[selected_organization][holidays][][name]	string	*
user[selected_organization][holidays][][holiday_periods][]	array of objects (HolidayPeriod)	*	One Holiday has Many Periods.
user[selected_organization][holidays][][holiday_periods][][id]	integer	*
user[selected_organization][holidays][][holiday_periods][][year]	integer	*
user[selected_organization][holidays][][holiday_periods][][start]	DateTime	*
user[selected_organization][holidays][][holiday_periods][][end]	DateTime	*
user[selected_organization][holidays][][groups][]	array of objects (Group)	*
user[selected_organization][holidays][][enabled]	boolean	*
user[selected_organization][categories][]	array of objects (Category)	*
user[selected_organization][tag_levels][]	array of objects (TagLevel)	>=3
user[selected_organization][tag_levels][][id]	integer	*
user[selected_organization][tag_levels][][index]	integer	*
user[selected_organization][tag_levels][][name]	string	*
user[selected_organization][tag_levels][][required]	boolean	*
user[selected_organization][vats][]	array of objects (Vat)	*
user[selected_organization][vats][][id]	integer	*
user[selected_organization][vats][][name]	string	*
user[selected_organization][vats][][percentage]	float	*
user[selected_organization][vats][][enabled]	boolean	*
user[selected_organization][vats][][country]	string	*
user[selected_organization][vats][][code]		*
user[selected_organization][vats][][code2]		*
user[selected_organization][settings]	object (Settings)	*
user[selected_organization][settings][default_mileage_rate]	float	*
user[selected_organization][settings][rate_per_mile]	float	<=3
user[selected_organization][settings][rate_per_kilometer]	float	<=3
user[selected_organization][settings][id]	integer	*
user[selected_organization][settings][currency]	string	*
user[selected_organization][settings][passcode_required]	boolean	*
user[selected_organization][settings][passcode_length]	integer	*
user[selected_organization][settings][resource_required]	boolean	*
user[selected_organization][settings][description_required]	boolean	*
user[selected_organization][settings][country_enabled]	boolean	*
user[selected_organization][settings][country_required]	boolean	*
user[selected_organization][settings][available_countries][]	array of strings	*
user[selected_organization][settings][category_enabled]	boolean	*
user[selected_organization][settings][category_required]	boolean	*
user[selected_organization][settings][tag_enabled]	boolean	>=4
user[selected_organization][settings][tag_level_check_per_report]	integer	>=4
user[selected_organization][settings][one_manager_per_report]	boolean	>=4.1
user[selected_organization][settings][carbon_copy_field_enabled]	boolean	*
user[selected_organization][settings][payment_method_enabled]	boolean	*
user[selected_organization][settings][payment_method_required]	boolean	*
user[selected_organization][settings][app_input_vat]	boolean	*
user[selected_organization][settings][pdf_one_per_page]	boolean	*
user[selected_organization][settings][mileage_enabled]	boolean	*
user[selected_organization][settings][mileage_distance_fixed]	boolean	*
user[selected_organization][settings][mileage_shortest_distance]	boolean	*
user[selected_organization][settings][settings_modules][]	array of objects (SettingsModule)	*
user[selected_organization][settings][settings_modules][][id]	integer	*
user[selected_organization][settings][settings_modules][][module]	object (Module)	*
user[selected_organization][settings][settings_modules][][module][id]	integer	*
user[selected_organization][settings][settings_modules][][module][key]	string	*
user[selected_organization][settings][settings_modules][][module][name]	string	*
user[selected_organization][settings][settings_modules][][groups][]	array of objects (Group)	*
user[selected_organization][settings][legacy_mode]	boolean	*
user[selected_organization][settings][manager_fixed]	boolean	*
user[selected_organization][settings][user_advances_enabled]	boolean	*
user[selected_organization][settings][advance_currency_enabled]	boolean	*
user[selected_organization][settings][compensation_enabled]	boolean	*
user[selected_organization][settings][track_billable]	boolean	*
user[selected_organization][settings][billable_label]	string	>=4
user[selected_organization][settings][billable_groups][]	array of objects (Group)	>=4
user[selected_organization][settings][currency_fixed]	boolean	*
user[selected_organization][settings][signature_required]	boolean	>=4
user[selected_organization][settings][time_enabled]	boolean	*
user[selected_organization][settings][time_period]	integer	*
user[selected_organization][settings][time_start_of_week]	integer	*
user[selected_organization][settings][help_enabled]	boolean	*
user[selected_organization][settings][smart_report_enabled]	boolean	*
user[selected_organization][settings][smart_report_frequence]	object (Frequence)	*
user[selected_organization][settings][smart_report_frequence][id]	integer	*
user[selected_organization][settings][smart_report_frequence][period]	integer	*
user[selected_organization][settings][smart_report_frequence][day]	integer	*
user[selected_organization][settings][smart_report_frequence][not_before]	DateTime	*
user[selected_organization][settings][smart_report_frequence][not_after]	DateTime	*
user[selected_organization][settings][report_default_name]	string	*
user[selected_organization][settings][trip_default_name]	string	*
user[selected_organization][settings][default_advance_category]	object (Category)	*
user[selected_organization][settings][advance_resource_required]	boolean	*
user[selected_organization][settings][default_region]	object (Place)	*
user[selected_organization][settings][default_region][label]	string	*
user[selected_organization][settings][default_region][id]	integer	*
user[selected_organization][settings][default_region][country]	string	*
user[selected_organization][settings][default_region][city]	string	*
user[selected_organization][settings][default_region][google_id]	string	*
user[selected_organization][settings][default_region][type]	string	*
user[selected_organization][settings][default_region][country_code]	string	*
user[selected_organization][settings][default_region][timezone]	string	*
user[selected_organization][settings][default_region][latitude]	float	*
user[selected_organization][settings][default_region][longitude]	float	*
user[selected_organization][settings][default_region][whitelisted]	boolean	*
user[selected_organization][settings][one_payment_method_per_report]	boolean	>=4.1
user[selected_organization][settings][max_expenses_per_report]	integer	*
user[selected_organization][settings][reject_comment_required]	boolean	*
user[selected_organization][settings][passcodeLength]		*
user[selected_organization][settings][maxExpensesPerReport]		*
user[selected_organization][disabled]	boolean	*
user[selected_organization][adp_account]	object (AdpAccount)	*
user[selected_organization][adp_account][id]	integer	*
user[selected_organization][payment_methods][]	array of objects (PaymentMethod)	*
user[selected_organization][payment_methods][][users][]	array of integers	*	Get id of related users.
user[selected_organization][payment_methods][][id]	integer	*
user[selected_organization][payment_methods][][name]	string	*
user[selected_organization][payment_methods][][code]	string	*
user[selected_organization][payment_methods][][code2]	string	*
user[selected_organization][payment_methods][][enabled]	boolean	*
user[selected_organization][payment_methods][][type]	integer	*
user[selected_organization][payment_methods][][issuer]	integer	*
user[selected_organization][payment_methods][][category_expenditure_cash]	object (Category)	*
user[selected_organization][payment_methods][][category_expenditure_private]	object (Category)	*
user[selected_organization][payment_methods][][assign_to]	integer	*
user[selected_organization][payment_methods][][condition]		*
user[selected_organization][payment_methods][][number]		*
user[selected_organization][export_formats][]	array of objects (ExportFormat)	*	ArrayCollection $exportFormats.
user[selected_organization][export_formats][][id]	integer	*
user[selected_organization][export_formats][][type]	string	*
user[selected_organization][export_formats][][name]	string	*
user[selected_organization][export_formats][][file]		*
user[selected_organization][compensation_types][]	array of objects (CompensationType)	*
user[selected_organization][compensation_types][][id]	integer	*
user[selected_organization][compensation_types][][type]	integer	*
user[selected_organization][compensation_types][][name]	string	*
user[selected_organization][compensation_types][][min]	integer	*
user[selected_organization][compensation_types][][currency]	string	*
user[selected_organization][compensation_types][][max]	integer	*
user[selected_organization][compensation_types][][step]	float	*
user[selected_organization][compensation_types][][enabled]	boolean	*
user[selected_organization][compensation_types][][unit]	integer	*
user[selected_organization][compensation_types][][rate]	float	*
user[selected_organization][compensation_types][][rate_fixed]	boolean	*
user[selected_organization][compensation_types][][vat]	object (Vat)	*
user[selected_organization][compensation_types][][vat_fixed]	boolean	*
user[selected_organization][compensation_types][][category_enabled]	boolean	*
user[selected_organization][compensation_types][][category_required]	boolean	*
user[selected_organization][compensation_types][][category_fixed]	boolean	*
user[selected_organization][compensation_types][][category]	object (Category)	*
user[selected_organization][compensation_types][][tag_enabled]	boolean	>=4
user[selected_organization][compensation_types][][tag_fixed]	boolean	>=4
user[selected_organization][compensation_types][][tag1]	object (Tag)	>=4
user[selected_organization][compensation_types][][tag1][id]	integer	*
user[selected_organization][compensation_types][][tag1][name]	string	*
user[selected_organization][compensation_types][][tag1][explanation]	string	*
user[selected_organization][compensation_types][][tag1][enabled]	boolean	*
user[selected_organization][compensation_types][][tag1][code]	string	*
user[selected_organization][compensation_types][][tag1][code2]	string	*
user[selected_organization][compensation_types][][tag1][code3]	string	*
user[selected_organization][compensation_types][][tag1][index]	integer	*
user[selected_organization][compensation_types][][tag1][groups][]	array of objects (Group)	*
user[selected_organization][compensation_types][][tag1][types][]	array of integers	*
user[selected_organization][compensation_types][][tag1][parent]	object (Tag)	>=4
user[selected_organization][compensation_types][][tag1][manager]	object (User)	*
user[selected_organization][compensation_types][][tag1][proof_required]	boolean	*
user[selected_organization][compensation_types][][tag2]	object (Tag)	>=4
user[selected_organization][compensation_types][][country]	string	*
user[selected_organization][compensation_types][][country_fixed]	boolean	*
user[selected_organization][compensation_types][][files_enabled]	boolean	*
user[selected_organization][compensation_types][][files_required]	boolean	*
user[selected_organization][compensation_types][][description_enabled]	boolean	*
user[selected_organization][compensation_types][][description_required]	boolean	*
user[selected_organization][compensation_types][][groups][]	array of objects (Group)	*
user[selected_organization][compensation_types][][code]		*
user[selected_organization][mileage_rates][]	array of objects (MileageRate)	*
user[selected_organization][mileage_rates][][mode_of_transport]	string	*
user[selected_organization][mileage_rates][][id]	integer	*
user[selected_organization][mileage_rates][][name]	string	*
user[selected_organization][mileage_rates][][unit]	integer	*
user[selected_organization][mileage_rates][][rate]	float	*
user[selected_organization][mileage_rates][][currency]	string	*
user[selected_organization][mileage_rates][][untaxed]	float	*
user[selected_organization][mileage_rates][][category]	object (Category)	*
user[selected_organization][mileage_rates][][groups][]	array of objects (Group)	*
user[selected_organization][mileage_rates][][enabled]	boolean	*
user[selected_organization][corporate_identity]	object (CorporateIdentity)	*
user[selected_organization][corporate_identity][id]	integer	*
user[selected_organization][corporate_identity][primary_color]	string	*
user[selected_organization][corporate_identity][logo_color]	string	*
user[selected_organization][corporate_identity][app_icon]	string	*
user[selected_organization][corporate_identity][app_main_tint_color]	string	*
user[selected_organization][corporate_identity][app_secondary_tint_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_border_color]	string	*
user[selected_organization][corporate_identity][app_side_menu_top_color]	string	*
user[selected_organization][corporate_identity][app_expense_button_text_color]	string	*
user[selected_organization][corporate_identity][app_table_view_background_color]	string	*
user[selected_organization][corporate_identity][reply_to]	string	*
user[selected_organization][corporate_identity][from_name]	string	*
user[selected_organization][corporate_identity][sender_name]	string	*
user[selected_organization][corporate_identity][regulations]	string	*
user[selected_organization][corporate_identity][translations][]	array of objects (Translation)	*
user[selected_organization][corporate_identity][translations][][id]	integer	*
user[selected_organization][corporate_identity][translations][][key]	string	*
user[selected_organization][corporate_identity][translations][][locale]	string	*
user[selected_organization][corporate_identity][translations][][translation]	string	*
user[selected_organization][corporate_identity][translations][][identity]	object (CorporateIdentity)	*
user[selected_organization][corporate_identity][submitter_signature]	string	*
user[selected_organization][corporate_identity][approver_signature]	string	*
user[selected_organization][activities][]	array of objects (Activity)	*
user[selected_organization][activities][][id]	integer	*
user[selected_organization][activities][][hash]	string	*
user[selected_organization][activities][][name]	string	*
user[selected_organization][activities][][groups][]	array of objects (Group)	*
user[selected_organization][activities][][enabled]	boolean	*
user[selected_organization][activities][][comments_enabled]	boolean	*
user[selected_organization][activities][][comments_required]	boolean	*
user[selected_organization][activities][][default]	boolean	*
user[selected_organization][activities][][days][]	array of integers	*
user[selected_organization][activities][][holidays_allowed]	boolean	*
user[selected_organization][activities][][maximum]	integer	*
user[selected_organization][activities][][future_days]	integer	*
user[selected_organization][activities][][futureDays]		*
user[selected_organization][address2]		*
user[selected_organization][country]		*
user[selected_organization][taxNumber]		*
user[selected_organization][iban]		*
user[code]	string	*
user[submits_to]	object (User)	*
user[approves_to]	object (User)	*
user[locale]	string	*
user[budget]	float	>=4
user[field_values][]	array of objects (CustomFieldValue)	*
user[field_values][][field_id]	integer	*
user[field_values][][id]	integer	*
user[field_values][][field]	object (CustomField)	*
user[field_values][][field][category_id]	integer	*	This is here for backwards compatibility in the app. Please don't use it.
user[field_values][][field][category_ids][]	array of integers	*
user[field_values][][field][parent_id]	integer	*
user[field_values][][field][parent_option_id]	integer	*
user[field_values][][field][id]	integer	*
user[field_values][][field][name]	string	*
user[field_values][][field][type]	integer	*
user[field_values][][field][order]	string	*
user[field_values][][field][placeholder]	string	*
user[field_values][][field][required]	boolean	*
user[field_values][][field][default_value]	string	*
user[field_values][][field][default_option]	object (CustomFieldOption)	*
user[field_values][][field][default_option][parent_id]	integer	*	Get parent id.
user[field_values][][field][default_option][id]	integer	*
user[field_values][][field][default_option][value]	string	*
user[field_values][][field][default_option][name]	string	*
user[field_values][][field][default_option][text1]	string	*
user[field_values][][field][default_option][text2]	string	*
user[field_values][][field][default_option][enabled]	boolean	*
user[field_values][][field][default_option][groups][]	array of objects (Group)	*
user[field_values][][field][options][]	array of objects (CustomFieldOption)	*
user[field_values][][field][user_editable]	boolean	*	@ORM\Column(name="userEditable", type="boolean")
user[field_values][][field][header_field]	boolean	*	@ORM\Column(name="headerField", type="boolean")
user[field_values][][field][regex]	string	*	@ORM\Column(type="text", nullable=true)
user[field_values][][field][enabled]	boolean	*	@ORM\Column(type="boolean")
user[field_values][][field][key]	string	*
user[field_values][][field][allow_user_default]	boolean	*
user[field_values][][field][sort]		*
user[field_values][][field][defaultValue]		*
user[field_values][][option]	object (CustomFieldOption)	*
user[field_values][][option][parent_id]	integer	*	Get parent id.
user[field_values][][option][id]	integer	*
user[field_values][][option][value]	string	*
user[field_values][][option][name]	string	*
user[field_values][][option][text1]	string	*
user[field_values][][option][text2]	string	*
user[field_values][][option][enabled]	boolean	*
user[field_values][][option][groups][]	array of objects (Group)	*
user[field_values][][value]	string	*
user[default_currency]	string	*
user[default_country]	string	*
user[default_category]	object (Category)	*
user[default_tag1]	object (Tag)	>=4
user[default_tag1][id]	integer	*
user[default_tag1][name]	string	*
user[default_tag1][explanation]	string	*
user[default_tag1][enabled]	boolean	*
user[default_tag1][code]	string	*
user[default_tag1][code2]	string	*
user[default_tag1][code3]	string	*
user[default_tag1][index]	integer	*
user[default_tag1][groups][]	array of objects (Group)	*
user[default_tag1][types][]	array of integers	*
user[default_tag1][parent]	object (Tag)	>=4
user[default_tag1][manager]	object (User)	*
user[default_tag1][proof_required]	boolean	*
user[default_tag2]	object (Tag)	>=4
user[default_tag3]	object (Tag)	>=4
user[default_payment_method]	object (PaymentMethod)	*
user[default_payment_method][users][]	array of integers	*	Get id of related users.
user[default_payment_method][id]	integer	*
user[default_payment_method][name]	string	*
user[default_payment_method][code]	string	*
user[default_payment_method][code2]	string	*
user[default_payment_method][enabled]	boolean	*
user[default_payment_method][type]	integer	*
user[default_payment_method][issuer]	integer	*
user[default_payment_method][category_expenditure_cash]	object (Category)	*
user[default_payment_method][category_expenditure_private]	object (Category)	*
user[default_payment_method][assign_to]	integer	*
user[default_payment_method][condition]		*
user[default_payment_method][number]		*
user[default_from_location]	object (Location)	*
user[default_from_location][id]	integer	*
user[default_from_location][query]	string	*
user[default_from_location][city]	string	*
user[default_from_location][country]	string	*
user[default_from_location][address]	string	*
user[default_from_location][address_number]	string	*
user[default_from_location][order]	integer	*
user[default_from_location][latitude]	float	*
user[default_from_location][longitude]	float	*
user[default_from_location][label]	string	*
user[default_to_location]	object (Location)	*
user[uuid]	string	*
user[firstName]		*
user[lastName]		*
user[plainPassword]		*
user[registrationCode]		*
user[code2]		*
user[accountNumber]		*
user[emailAlternative]		*
author	object (User)	*
hash	string	*

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/categories

Get the list of categories.

Documentation
Sandbox

Documentation

Get the list of categories.

Requirements

Name	Requirement	Type	Description
organization_id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v4/organizations/{organization_id}/categories

Edit an category entity.

Documentation
Sandbox

Documentation

Edit an category entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+

Return

Parameter	Type	Versions
200 - Successful transaction
name	string	*
code	string	*
code2	string	*
code3	string	*
code4	string	*
id	integer	*
explanation	string	*
enabled	boolean	*
groups[]	array of objects (Group)	*
groups[][id]	integer	*
groups[][name]	string	*
groups[][enabled]	boolean	*
groups[][code]	string	*
groups[][creation_date]	DateTime	*
vats[]	array of objects (Vat)	*
vats[][id]	integer	*
vats[][name]	string	*
vats[][percentage]	float	*
vats[][enabled]	boolean	*
vats[][country]	string	*
vats[][code]		*
vats[][code2]		*
vat_fixed	boolean	*
types[]	array of integers	*
resource_required	boolean	*
proof_required	boolean	*

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/v4/organizations/{organization_id}/categories/{id}

Delete an category entity.

Documentation
Sandbox

Documentation

Delete an category entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/categories/{id}

Get information on a single category entity.

Documentation
Sandbox

Documentation

Get information on a single category entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Return

Parameter	Type	Versions
200 - Successful transaction
name	string	*
code	string	*
code2	string	*
code3	string	*
code4	string	*
id	integer	*
explanation	string	*
enabled	boolean	*
groups[]	array of objects (Group)	*
groups[][id]	integer	*
groups[][name]	string	*
groups[][enabled]	boolean	*
groups[][code]	string	*
groups[][creation_date]	DateTime	*
vats[]	array of objects (Vat)	*
vats[][id]	integer	*
vats[][name]	string	*
vats[][percentage]	float	*
vats[][enabled]	boolean	*
vats[][country]	string	*
vats[][code]		*
vats[][code2]		*
vat_fixed	boolean	*
types[]	array of integers	*
resource_required	boolean	*
proof_required	boolean	*

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v4/organizations/{organization_id}/categories/{id}

Edit an category entity.

Documentation
Sandbox

Documentation

Edit an category entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Return

Parameter	Type	Versions
200 - Successful transaction
name	string	*
code	string	*
code2	string	*
code3	string	*
code4	string	*
id	integer	*
explanation	string	*
enabled	boolean	*
groups[]	array of objects (Group)	*
groups[][id]	integer	*
groups[][name]	string	*
groups[][enabled]	boolean	*
groups[][code]	string	*
groups[][creation_date]	DateTime	*
vats[]	array of objects (Vat)	*
vats[][id]	integer	*
vats[][name]	string	*
vats[][percentage]	float	*
vats[][enabled]	boolean	*
vats[][country]	string	*
vats[][code]		*
vats[][code2]		*
vat_fixed	boolean	*
types[]	array of integers	*
resource_required	boolean	*
proof_required	boolean	*

Status Codes

Status Code	Description
200	Successful transaction
400	Data submitted is not valid or incomplete
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/categories/{id}/disable

Disable or enable a category entity.

Documentation
Sandbox

Documentation

Disable or enable a category entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Status Codes

Status Code	Description
204	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/categories/{id}/enable

Disable or enable a category entity.

Documentation
Sandbox

Documentation

Disable or enable a category entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Status Codes

Status Code	Description
204	Successful transaction
401	Access denied
403	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/compensationtypes

Get the list of compensationTypes.

Documentation
Sandbox

Documentation

Get the list of compensationTypes.

Requirements

Name	Requirement	Type	Description
organization_id	\d+

Status Codes

Status Code	Description
200	Successful transaction
401	Access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations/{organization_id}/compensationtypes/{id}

Get information on a single category entity.

Documentation
Sandbox

Documentation

Get information on a single category entity.

Requirements

Name	Requirement	Type	Description
organization_id	\d+
id	\d+

Return

Parameter	Type	Versions
200 - Successful transaction
name	string	*
code		*
id	integer	*
type	integer	*
min	integer	*
currency	string	*
max	integer	*
step	float	*
enabled	boolean	*
unit	integer	*
rate	float	*
rate_fixed	boolean	*
vat	object (Vat)	*
vat[id]	integer	*
vat[name]	string	*
vat[percentage]	float	*
vat[enabled]	boolean	*
vat[country]	string	*
vat[code]		*
vat[code2]		*
vat_fixed	boolean	*

API documentation

Declaree API webservices documentation

Authentication

API key

Form login

Basic authentication (DEPRICATED)

Json Web Token (+SSO)

Support

API reference

POST /api/login

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/configuration

Documentation

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/entries/{id}

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/flights

Documentation

Filters

Return

200 - Successful transaction

Status Codes

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/logout

Documentation

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v4/me

Documentation

Return

200 - Successful transaction

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v4/organizations

Documentation

Filters

Status Codes

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v4/organizations

Documentation

Status Codes