Procore.Api.FieldProductivityTimecardTimecardEntries (procore_sdk v0.3.0)
API calls for all endpoints tagged FieldProductivityTimecardTimecardEntries
.
Summary
Functions
List timecard entries (Company) Return a list of all Timecard Entries, serialized according to the MyTime field set
Show timecard entry change history (Company) Returns the change history for a Timecard Entry.
Delete timecard entry (Company) Detete a specific Timecard Entry.
Show timecard entry (Company) Return detailed information about a specific Timecard Entry.
Update timecard entry (Company) Update a specified Timecard Entry.
Create timecard entry (Company) Create a new Timecard Entry.
List timecard entries (Project) Returns a list of all timecard entries for the current date. See Working with Daily Logs for information on filtering the response using the log_date, start_date, and end_date parameters.
Delete timecard entry (Project) Delete a specific timecard entry.
Show timecard entry (Project) Return detailed information about a specific timecard entry.
Update timecard entry (Project) Update a specific timecard entry. #### See - Daily Log guide - for additional info on * Attachments
Remove signature from timecard entry (Project) Remove the signature ID from the provided timecard entry.
Update timecard entry signature (Project) Update timecard entry signature with the provided signature ID.
Create timecard entry (Project) Create a new Timecard Entry. #### See - Daily Log guide - for additional info on * Attachments
List timecard entries Return a list of all Timecard Entries within a specified date range.
Delete timecard entry Detete a specific Timecard Entry.
Show timecard entry Return detailed information about a specific Timecard Entry.
Update timecard entry Update a specified Timecard Entry.
Create timecard entry Create a new Timecard Entry.
Functions
rest_v10_companies_company_id_timecard_entries_get(connection, procore_company_id, company_id, opts \\ [])
@spec rest_v10_companies_company_id_timecard_entries_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List timecard entries (Company) Return a list of all Timecard Entries, serialized according to the MyTime field set
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.opts
(keyword): Optional parameters:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[party_id]"
([integer()]): Return item(s) with the specified Party ID.:"filters[in_progress_only]"
(boolean()): Return work in progress item(s).:"filters[include_in_progress]"
(boolean()): Return available and work in progress item(s).:"filters[updated_at]"
(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD
...YYYY-MM-DD
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00
...YYYY-MM-DDTHH:MM:SS+XX:00
- Datetime with Custom Offset:page
(integer()): Page:per_page
(integer()): Elements per page:start_date
(Date.t): The beginning of the date range for entries. (YYYY-MM-DD):end_date
(Date.t): The ending of the date range for entries. (YYYY-MM-DD):start_time_in
(String.t): The beginning of the time_in range for entries (YYYY-MM-DDTHH:MM:SSZ). "Z" represents the timezone offset (i.e. -08:00, -0800). Optionally you may pass the literal "Z" which also means "UTC".:end_time_in
(String.t): The ending of the time_in range for entries (YYYY-MM-DDTHH:MM:SSZ). "Z" represents the timezone offset (i.e. -08:00, -0800). Optionally you may pass the literal "Z" which also means "UTC".:use_filter_tz
(String.t): When passed as "true" the timezone from start_time_in or end_time_in will be used for all timestamps in the response. Otherwise they'll use UTC.:serializer_view
(String.t): Changes what fields are included in the response.
Returns
{:ok, [%RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_timecard_entries_id_change_history_get(connection, procore_company_id, id, company_id, opts \\ [])
@spec rest_v10_companies_company_id_timecard_entries_id_change_history_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.TimecardEntryChangeHistory.t()]} | {:error, Tesla.Env.t()}
Show timecard entry change history (Company) Returns the change history for a Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): ID of the timecard entrycompany_id
(integer()): Unique identifier for the company.opts
(keyword): Optional parameters
Returns
{:ok, [%TimecardEntryChangeHistory{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_timecard_entries_id_delete(connection, procore_company_id, id, company_id, opts \\ [])
@spec rest_v10_companies_company_id_timecard_entries_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Delete timecard entry (Company) Detete a specific Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): ID of the timecard entrycompany_id
(integer()): Unique identifier for the company.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_timecard_entries_id_get(connection, procore_company_id, id, company_id, opts \\ [])
@spec rest_v10_companies_company_id_timecard_entries_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Show timecard entry (Company) Return detailed information about a specific Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): ID of the timecard entrycompany_id
(integer()): Unique identifier for the company.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_timecard_entries_id_patch(connection, procore_company_id, id, company_id, rest_v10_companies_company_id_timecard_entries_id_patch_request, opts \\ [])
@spec rest_v10_companies_company_id_timecard_entries_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesIdPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Update timecard entry (Company) Update a specified Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): ID of the timecard entrycompany_id
(integer()): Unique identifier for the company.rest_v10_companies_company_id_timecard_entries_id_patch_request
(RestV10CompaniesCompanyIdTimecardEntriesIdPatchRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_timecard_entries_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_timecard_entries_post_request, opts \\ [])
@spec rest_v10_companies_company_id_timecard_entries_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Create timecard entry (Company) Create a new Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.rest_v10_companies_company_id_timecard_entries_post_request
(RestV10CompaniesCompanyIdTimecardEntriesPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10CompaniesCompanyIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_timecard_entries_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_timecard_entries_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List timecard entries (Project) Returns a list of all timecard entries for the current date. See Working with Daily Logs for information on filtering the response using the log_date, start_date, and end_date parameters.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:log_date
(Date.t): Timecard entries at the specified date. (YYYY-MM-DD):start_date
(Date.t): The beginning of the date range for timecard entries. (YYYY-MM-DD) Start date is inclusive.:end_date
(Date.t): The end of the date range for timecard entries. (YYYY-MM-DD) End date is inclusive.:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[created_by_id]"
([integer()]): Returns item(s) created by the specified User IDs.
Returns
{:ok, [%RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_timecard_entries_id_delete(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_timecard_entries_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete timecard entry (Project) Delete a specific timecard entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): ID of the timecard entryopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_timecard_entries_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_timecard_entries_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Show timecard entry (Project) Return detailed information about a specific timecard entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): ID of the timecard entryopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_timecard_entries_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_timecard_entries_id_patch_request, opts \\ [])
@spec rest_v10_projects_project_id_timecard_entries_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdTimecardEntriesIdPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Update timecard entry (Project) Update a specific timecard entry. #### See - Daily Log guide - for additional info on * Attachments
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): ID of the timecard entryrest_v10_projects_project_id_timecard_entries_id_patch_request
(RestV10ProjectsProjectIdTimecardEntriesIdPatchRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_timecard_entries_id_remove_signature_patch(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_timecard_entries_id_remove_signature_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Remove signature from timecard entry (Project) Remove the signature ID from the provided timecard entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): The ID of the timecard entry.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_timecard_entries_id_sign_patch(connection, procore_company_id, id, project_id, rest_v10_projects_project_id_timecard_entries_id_sign_patch_request, opts \\ [])
@spec rest_v10_projects_project_id_timecard_entries_id_sign_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdTimecardEntriesIdSignPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Update timecard entry signature (Project) Update timecard entry signature with the provided signature ID.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): The ID of the timecard entry.project_id
(integer()): Unique identifier for the project.rest_v10_projects_project_id_timecard_entries_id_sign_patch_request
(RestV10ProjectsProjectIdTimecardEntriesIdSignPatchRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_timecard_entries_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_timecard_entries_post_request, opts \\ [])
@spec rest_v10_projects_project_id_timecard_entries_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdTimecardEntriesPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Create timecard entry (Project) Create a new Timecard Entry. #### See - Daily Log guide - for additional info on * Attachments
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.rest_v10_projects_project_id_timecard_entries_post_request
(RestV10ProjectsProjectIdTimecardEntriesPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTimecardEntriesGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_timecard_entries_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_timecard_entries_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10TimecardEntriesGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List timecard entries Return a list of all Timecard Entries within a specified date range.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:start_date
(Date.t): The beginning of the date range for entries. (YYYY-MM-DD):end_date
(Date.t): The end of the date range for entries. (YYYY-MM-DD):page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10TimecardEntriesGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_timecard_entries_id_delete(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_timecard_entries_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete timecard entry Detete a specific Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): ID of the timecard entryproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_timecard_entries_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_timecard_entries_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdProjectTimecardEntriesPost200Response.t()} | {:error, Tesla.Env.t()}
Show timecard entry Return detailed information about a specific Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): ID of the timecard entryproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdProjectTimecardEntriesPost200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_timecard_entries_id_patch(connection, procore_company_id, id, rest_v10_timecard_entries_post_request, opts \\ [])
@spec rest_v10_timecard_entries_id_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10TimecardEntriesPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdProjectTimecardEntriesPost200Response.t()} | {:error, Tesla.Env.t()}
Update timecard entry Update a specified Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): ID of the timecard entryrest_v10_timecard_entries_post_request
(RestV10TimecardEntriesPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdProjectTimecardEntriesPost200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_timecard_entries_post(connection, procore_company_id, rest_v10_timecard_entries_post_request, opts \\ [])
@spec rest_v10_timecard_entries_post( Tesla.Env.client(), integer(), Procore.Model.RestV10TimecardEntriesPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdProjectTimecardEntriesPost200Response.t()} | {:error, Tesla.Env.t()}
Create timecard entry Create a new Timecard Entry.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.rest_v10_timecard_entries_post_request
(RestV10TimecardEntriesPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdProjectTimecardEntriesPost200Response.t}
on success{:error, Tesla.Env.t}
on failure