Skip to main content
Server path: /rentman-people | Type: Application | PCID required: Yes

Tools

ToolDescription
rentman_people_create_contactCreate Contact item.
rentman_people_create_contact_personCreate ContactPerson item.
rentman_people_create_crew_availabilityCreate CrewAvailability item.
rentman_people_delete_contactDelete Contact item.
rentman_people_delete_contact_personDelete ContactPerson item.
rentman_people_delete_crew_availabilityDelete CrewAvailability item.
rentman_people_get_contact_collectionGet Contact collection.
rentman_people_get_contact_contact_person_collectionGet ContactPerson collection.
rentman_people_get_contact_file_collectionGet File collection.
rentman_people_get_contact_file_folder_collectionGet FileFolder collection.
rentman_people_get_contact_itemGet Contact item.
rentman_people_get_contact_person_collectionGet ContactPerson collection.
rentman_people_get_contact_person_file_collectionGet File collection.
rentman_people_get_contact_person_file_folder_collectionGet FileFolder collection.
rentman_people_get_contact_person_itemGet ContactPerson item.
rentman_people_get_crew_appointment_collectionGet Appointment collection.
rentman_people_get_crew_availability_collectionGet CrewAvailability collection.
rentman_people_get_crew_availability_itemGet CrewAvailability item.
rentman_people_get_crew_collectionGet Crew collection.
rentman_people_get_crew_crew_availability_collectionGet CrewAvailability collection.
rentman_people_get_crew_crew_rates_collectionGet CrewRates collection.
rentman_people_get_crew_file_collectionGet File collection.
rentman_people_get_crew_file_folder_collectionGet FileFolder collection.
rentman_people_get_crew_invitations_collectionGet Invitations collection.
rentman_people_get_crew_itemGet Crew item.
rentman_people_get_crew_rates_collectionGet CrewRates collection.
rentman_people_get_crew_rates_itemGet CrewRates item.
rentman_people_update_contactUpdate Contact item.
rentman_people_update_contact_personUpdate ContactPerson item.
rentman_people_update_crew_availabilityUpdate CrewAvailability item.

rentman_people_create_contact

Create Contact item. Parameters:
ParameterTypeRequiredDefaultDescription
accounting_codestringNoExternal identifier used for integrations with accounting software.
admin_contactpersonstringNoThis contact person is automatically selected when creating invoices.
bank_accountstringNoBank Account
bicstringNoThe bic value
codestringNoAutomatically generated if left empty.
commerce_codestringNoCommerce Code
contact_warningstringNoThis warning is shown when this contact is selected as a client in a project.
countrystringNoThe country value
customobjectNoThe object containing all custom defined fields.
default_personstringNoThis contact person is automatically selected if you choose this contact in a project or subrental.
discount_crewnumberNoDiscount applied to the ‘crew’ category upon selecting this contact as a client in a project.
discount_rentalnumberNoDiscount applied to the ‘rental’ category upon selecting this contact as a client in a project.
discount_salenumberNoDiscount applied to the ‘sales’ category upon selecting this contact as a client in a project.
discount_subrentnumberNoDiscount applied to rental equipment upon selecting this contact as a supplier in a subrental.
discount_totalnumberNoDiscount applied to the total (sub)project upon selecting this contact as a client in a project.
discount_transportnumberNoDiscount applied to the ‘transport’ category upon selecting this contact as a client in a project.
distancenumberNoDistance from warehouse to visiting address.
email_1stringNoEmail 1
email_2stringNoEmail 2
ext_name_linestringNoExt Name Line
firstnamestringNoThe firstname value
fiscal_codestringNoThis number is used in file exports of invoices.
folderstringNoThe folder value
genderstringNoThe gender value
imagestringNoThe image value
invoice_citystringNoInvoice City
invoice_countrystringNoInvoice Country
invoice_districtstringNoInvoice District
invoice_extra_address_linestringNoInvoice Extra Address Line
invoice_numberstringNoInvoice Number
invoice_postalcodestringNoInvoice Postalcode
invoice_statestringNoInvoice State
invoice_streetstringNoInvoice Street
invoice_unit_numberstringNoInvoice Unit Number
latitudenumberNoThe latitude value
longitudenumberNoThe longitude value
mailing_citystringNoMailing City
mailing_countrystringNoMailing Country
mailing_districtstringNoMailing District
mailing_extra_address_linestringNoMailing Extra Address Line
mailing_numberstringNoMailing Number
mailing_postalcodestringNoMailing Postalcode
mailing_statestringNoMailing State
mailing_streetstringNoMailing Street
mailing_unit_numberstringNoMailing Unit Number
namestringNoThe name value
phone_1stringNoPhone 1
phone_2stringNoPhone 2
projectnotestringNoThis remark is automatically added to projects upon selecting this contact as client or location.
projectnote_titlestringNoThis remark is automatically added to projects upon selecting this contact as client or location.
purchase_numberstringNoPurchase Number
surfixstringNoThe surfix value
surnamestringNoThe surname value
travel_timenumberNoTravel time (in minutes) from warehouse to visiting address.
typestringNoThe type value
VAT_codestringNoVAT Code
vendor_accounting_codestringNoExternal identifier used for integrations with accounting software.
visit_citystringNoVisit City
visit_districtstringNoVisit District
visit_extra_address_linestringNoVisit Extra Address Line
visit_numberstringNoVisit Number
visit_postalcodestringNoVisit Postalcode
visit_statestringNoVisit State
visit_streetstringNoVisit Street
visit_unit_numberstringNoVisit Unit Number
websitestringNoThe website value

rentman_people_create_contact_person

Create ContactPerson item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
citystringNoThe city value
countrystringNoThe country value
customobjectNoThe object containing all custom defined fields.
emailstringNoThe email value
firstnamestringNoThe firstname value
functionstringNoThe function value
lastnamestringNoThe lastname value
middle_namestringNoMiddle Name
mobilephonestringNoThe mobilephone value
numberstringNoThe number value
phonestringNoThe phone value
postalcodestringNoThe postalcode value
statestringNoThe state value
streetstringNoThe street value

rentman_people_create_crew_availability

Create CrewAvailability item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
endstringYesThe end value
last_updatedstringNoLast Updated
last_updaterstringNoLast Updater
recurrence_enddatestringNoRecurrence Enddate
recurrence_intervalintegerNointerval in how many days/weeks/months/years the availability should reoccur.
recurrence_interval_unitstringNoRecurrence Interval Unit
recurrence_weekdaysstringNoGENERATED FIELD. Use the integers: 0 = Monday, 1 = Tuesday, 2 = Wednesday, 3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday. E.g.: for a recurrence on Monday and Wednesday, use [0, 2].
recurrent_groupintegerNoRecurrent Group
remarkstringNoThe remark value
startstringYesThe start value
statusstringNoB - This value is returned when the crew availability status is available N - This value is returned when the crew availability status is unavailable O - This value is returned when the crew availability status is unknown .

rentman_people_delete_contact

Delete Contact item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_delete_contact_person

Delete ContactPerson item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_delete_crew_availability

Delete CrewAvailability item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_contact_collection

Get Contact collection.

rentman_people_get_contact_contact_person_collection

Get ContactPerson collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_contact_file_collection

Get File collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_contact_file_folder_collection

Get FileFolder collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_contact_item

Get Contact item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_contact_person_collection

Get ContactPerson collection.

rentman_people_get_contact_person_file_collection

Get File collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_contact_person_file_folder_collection

Get FileFolder collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_contact_person_item

Get ContactPerson item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_appointment_collection

Get Appointment collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_availability_collection

Get CrewAvailability collection.

rentman_people_get_crew_availability_item

Get CrewAvailability item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_collection

Get Crew collection.

rentman_people_get_crew_crew_availability_collection

Get CrewAvailability collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_crew_rates_collection

Get CrewRates collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_file_collection

Get File collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_file_folder_collection

Get FileFolder collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_invitations_collection

Get Invitations collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_item

Get Crew item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_get_crew_rates_collection

Get CrewRates collection.

rentman_people_get_crew_rates_item

Get CrewRates item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_people_update_contact

Update Contact item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
accounting_codestringNoExternal identifier used for integrations with accounting software.
admin_contactpersonstringNoThis contact person is automatically selected when creating invoices.
bank_accountstringNoBank Account
bicstringNoThe bic value
codestringNoAutomatically generated if left empty.
commerce_codestringNoCommerce Code
contact_warningstringNoThis warning is shown when this contact is selected as a client in a project.
countrystringNoThe country value
customobjectNoThe object containing all custom defined fields.
default_personstringNoThis contact person is automatically selected if you choose this contact in a project or subrental.
discount_crewnumberNoDiscount applied to the ‘crew’ category upon selecting this contact as a client in a project.
discount_rentalnumberNoDiscount applied to the ‘rental’ category upon selecting this contact as a client in a project.
discount_salenumberNoDiscount applied to the ‘sales’ category upon selecting this contact as a client in a project.
discount_subrentnumberNoDiscount applied to rental equipment upon selecting this contact as a supplier in a subrental.
discount_totalnumberNoDiscount applied to the total (sub)project upon selecting this contact as a client in a project.
discount_transportnumberNoDiscount applied to the ‘transport’ category upon selecting this contact as a client in a project.
distancenumberNoDistance from warehouse to visiting address.
email_1stringNoEmail 1
email_2stringNoEmail 2
ext_name_linestringNoExt Name Line
firstnamestringNoThe firstname value
fiscal_codestringNoThis number is used in file exports of invoices.
folderstringNoThe folder value
genderstringNoThe gender value
imagestringNoThe image value
invoice_citystringNoInvoice City
invoice_countrystringNoInvoice Country
invoice_districtstringNoInvoice District
invoice_extra_address_linestringNoInvoice Extra Address Line
invoice_numberstringNoInvoice Number
invoice_postalcodestringNoInvoice Postalcode
invoice_statestringNoInvoice State
invoice_streetstringNoInvoice Street
invoice_unit_numberstringNoInvoice Unit Number
latitudenumberNoThe latitude value
longitudenumberNoThe longitude value
mailing_citystringNoMailing City
mailing_countrystringNoMailing Country
mailing_districtstringNoMailing District
mailing_extra_address_linestringNoMailing Extra Address Line
mailing_numberstringNoMailing Number
mailing_postalcodestringNoMailing Postalcode
mailing_statestringNoMailing State
mailing_streetstringNoMailing Street
mailing_unit_numberstringNoMailing Unit Number
namestringNoThe name value
phone_1stringNoPhone 1
phone_2stringNoPhone 2
projectnotestringNoThis remark is automatically added to projects upon selecting this contact as client or location.
projectnote_titlestringNoThis remark is automatically added to projects upon selecting this contact as client or location.
purchase_numberstringNoPurchase Number
surfixstringNoThe surfix value
surnamestringNoThe surname value
travel_timenumberNoTravel time (in minutes) from warehouse to visiting address.
typestringNoThe type value
VAT_codestringNoVAT Code
vendor_accounting_codestringNoExternal identifier used for integrations with accounting software.
visit_citystringNoVisit City
visit_districtstringNoVisit District
visit_extra_address_linestringNoVisit Extra Address Line
visit_numberstringNoVisit Number
visit_postalcodestringNoVisit Postalcode
visit_statestringNoVisit State
visit_streetstringNoVisit Street
visit_unit_numberstringNoVisit Unit Number
websitestringNoThe website value

rentman_people_update_contact_person

Update ContactPerson item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
citystringNoThe city value
countrystringNoThe country value
customobjectNoThe object containing all custom defined fields.
emailstringNoThe email value
firstnamestringNoThe firstname value
functionstringNoThe function value
lastnamestringNoThe lastname value
middle_namestringNoMiddle Name
mobilephonestringNoThe mobilephone value
numberstringNoThe number value
phonestringNoThe phone value
postalcodestringNoThe postalcode value
statestringNoThe state value
streetstringNoThe street value

rentman_people_update_crew_availability

Update CrewAvailability item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
endstringYesThe end value
last_updatedstringNoLast Updated
last_updaterstringNoLast Updater
recurrence_enddatestringNoRecurrence Enddate
recurrence_intervalintegerNointerval in how many days/weeks/months/years the availability should reoccur.
recurrence_interval_unitstringNoRecurrence Interval Unit
recurrence_weekdaysstringNoGENERATED FIELD. Use the integers: 0 = Monday, 1 = Tuesday, 2 = Wednesday, 3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday. E.g.: for a recurrence on Monday and Wednesday, use [0, 2].
recurrent_groupintegerNoRecurrent Group
remarkstringNoThe remark value
startstringYesThe start value
statusstringNoB - This value is returned when the crew availability status is available N - This value is returned when the crew availability status is unavailable O - This value is returned when the crew availability status is unknown .