Procore.Api.ConstructionFinancialsCommitmentsPurchaseOrderContracts (procore_sdk v0.3.0)
API calls for all endpoints tagged ConstructionFinancialsCommitmentsPurchaseOrderContracts
.
Summary
Functions
List of Purchase Order Contracts Returns a list of all Purchase Order Contracts. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Delete Purchase Order Contract Deletes a Purchase Order Contract.
Show Purchase Order Contract Return detailed information on a Purchase Order Contract. ### Special notes (Tiers) The visibility of Change Order Packages, Potential Change Orders & Change Order Requests depends on the number of tiers defined in the Work Order Contract as follows: 1-tier: Change Order Packages 2-tier: Change Order Packages, Potential Change Orders 3-tier: Change Order Packages, Change Order Requests, Potential Change Orders
Update Purchase Order Contract Update a Purchase Order Contract.
Create Purchase Order Contract Create a Purchase Order Contract.
Sync Purchase Order Contracts This endpoint creates or updates a batch of Purchase Order Contracts. See Using Sync Actions for additional information.
Functions
rest_v10_purchase_order_contracts_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_purchase_order_contracts_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10PurchaseOrderContractsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List of Purchase Order Contracts Returns a list of all Purchase Order Contracts. 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.opts
(keyword): Optional parameters:view
(String.t): Specifies how much information to show for each purchase order contract. The compact view is returned by default.:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[status]"
(String.t): Return item(s) with the specified Purchase Order Contract status.:"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[include_deleted]"(String.t): Use 'only' for only deleted resources. Use 'with' for deleted and undeleted resources. -
:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. ### Returns -
, ...]}on success -
` on failure
rest_v10_purchase_order_contracts_id_delete(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_purchase_order_contracts_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete Purchase Order Contract Deletes a Purchase Order Contract.
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.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_purchase_order_contracts_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_purchase_order_contracts_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10PurchaseOrderContractsPost201Response.t()} | {:error, Tesla.Env.t()}
Show Purchase Order Contract Return detailed information on a Purchase Order Contract. ### Special notes (Tiers) The visibility of Change Order Packages, Potential Change Orders & Change Order Requests depends on the number of tiers defined in the Work Order Contract as follows: 1-tier: Change Order Packages 2-tier: Change Order Packages, Potential Change Orders 3-tier: Change Order Packages, Change Order Requests, Potential Change Orders
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.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10PurchaseOrderContractsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_purchase_order_contracts_id_patch(connection, procore_company_id, id, body27, opts \\ [])
@spec rest_v10_purchase_order_contracts_id_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.Body27.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10PurchaseOrderContractsPost201Response.t()} | {:error, Tesla.Env.t()}
Update Purchase Order Contract Update a Purchase Order Contract.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): IDbody27
(Body27):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.RestV10PurchaseOrderContractsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_purchase_order_contracts_post(connection, procore_company_id, body27, opts \\ [])
@spec rest_v10_purchase_order_contracts_post( Tesla.Env.client(), integer(), Procore.Model.Body27.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10PurchaseOrderContractsPost201Response.t()} | {:error, Tesla.Env.t()}
Create Purchase Order Contract Create a Purchase Order Contract.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.body27
(Body27):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.RestV10PurchaseOrderContractsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_purchase_order_contracts_sync_patch(connection, procore_company_id, body28, opts \\ [])
@spec rest_v10_purchase_order_contracts_sync_patch( Tesla.Env.client(), integer(), Procore.Model.Body28.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10PurchaseOrderContractsSyncPatch200Response.t()} | {:error, Tesla.Env.t()}
Sync Purchase Order Contracts This endpoint creates or updates a batch of Purchase Order Contracts. 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.body28
(Body28):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10PurchaseOrderContractsSyncPatch200Response.t}
on success{:error, Tesla.Env.t}
on failure