Procore.Api.ConstructionFinancialsChangeOrdersChangeOrderRequests (procore_sdk v0.3.0)
API calls for all endpoints tagged ConstructionFinancialsChangeOrdersChangeOrderRequests
.
Summary
Functions
List Change Order Requests Return a list of all Change Order Requests (COR) to a specific Contract in a Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Show Change Order Request Return detailed information about a specified Change Order Request (COR).
Update Change Order Request Update information about a specific Change Order Request (COR).
Create Change Order Request Create Change Order Request (COR).
Sync Change Order Requests This endpoint creates or updates a batch of Change Order Requests (COR). See Using Sync Actions for additional information.
Functions
rest_v10_change_order_requests_get(connection, procore_company_id, project_id, contract_id, opts \\ [])
@spec rest_v10_change_order_requests_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10ChangeOrderRequestsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List Change Order Requests Return a list of all Change Order Requests (COR) to a specific Contract in a Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
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.contract_id
(integer()): Contract IDopts
(keyword): Optional parameters:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[created_at]"
(Date.t): Return item(s) created 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 -
:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:
YYYY-MM-DD...
YYYY-MM-DD- Date
YYYY-MM-DDTHH:MM:SSZ...
YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC Offset
YYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[due_date]"(String.t): Returns item(s) due within the specified ISO 8601 datetime range. -
:"filters[invoiced_date]"(String.t): Returns item(s) invoiced within the specified ISO 8601 datetime range. -
:"filters[paid_date]"(String.t): Returns item(s) paid within the specified ISO 8601 datetime range. -
:page(integer()): Page -
:per_page(integer()): Elements per page ### Returns -
, ...]}on success -
` on failure
rest_v10_change_order_requests_id_get(connection, procore_company_id, id, project_id, contract_id, opts \\ [])
@spec rest_v10_change_order_requests_id_get( Tesla.Env.client(), integer(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.ArrayOfChangeOrderRequestsEntitiesInner.t()} | {:error, Tesla.Env.t()}
Show Change Order Request Return detailed information about a specified Change Order Request (COR).
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): IDproject_id
(integer()): Unique identifier for the project.contract_id
(integer()): Contract IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.ArrayOfChangeOrderRequestsEntitiesInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_change_order_requests_id_patch(connection, procore_company_id, id, rest_v10_change_order_requests_post_request, opts \\ [])
@spec rest_v10_change_order_requests_id_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10ChangeOrderRequestsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.ArrayOfChangeOrderRequestsEntitiesInner.t()} | {:error, Tesla.Env.t()}
Update Change Order Request Update information about a specific Change Order Request (COR).
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): IDrest_v10_change_order_requests_post_request
(RestV10ChangeOrderRequestsPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.ArrayOfChangeOrderRequestsEntitiesInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_change_order_requests_post(connection, procore_company_id, rest_v10_change_order_requests_post_request, opts \\ [])
@spec rest_v10_change_order_requests_post( Tesla.Env.client(), integer(), Procore.Model.RestV10ChangeOrderRequestsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10ChangeOrderRequestsPost201Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Create Change Order Request Create Change Order Request (COR).
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.rest_v10_change_order_requests_post_request
(RestV10ChangeOrderRequestsPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ChangeOrderRequestsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_change_order_requests_sync_patch(connection, procore_company_id, project_id, contract_id, change_order_request_sync, opts \\ [])
@spec rest_v10_change_order_requests_sync_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.ChangeOrderRequestSync.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdProjectsProjectIdTaskItemCommentsPost403Response.t()} | {:ok, Procore.Model.ArrayOfChangeOrderRequests.t()} | {:error, Tesla.Env.t()}
Sync Change Order Requests This endpoint creates or updates a batch of Change Order Requests (COR). See Using Sync Actions for additional information.
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.contract_id
(integer()): Contract IDchange_order_request_sync
(ChangeOrderRequestSync):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.ArrayOfChangeOrderRequests.t}
on success{:error, Tesla.Env.t}
on failure