Procore.Api.ConstructionFinancialsPrimeContractsPrimeContractLineItems (procore_sdk v0.3.0)
API calls for all endpoints tagged ConstructionFinancialsPrimeContractsPrimeContractLineItems
.
Summary
Functions
List Prime Contract line items Return a list of all Line Items for the Prime Contract. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Delete a Prime Contract line item Delete a Line Item from the Prime Contract.
Show Prime Contract line item Return a specific Line Item from the Prime Contract.
Update Prime Contract line item Update a Line Item from the Prime Contract. Note: A budget line item will automatically be created for Non-budgeted line items for all new projects and for projects enabled with Non-Budgeted line item beta functionality
Create Prime Contract line item Create a new Line Item for the Prime Contract. Note: A budget line item will automatically be created for Non-budgeted line items for all new projects and for projects enabled with Non-Budgeted line item beta functionality
Sync Prime Contract Line Items Sync Prime Contract Line Items.
Functions
rest_v10_prime_contracts_prime_contract_id_line_items_get(connection, procore_company_id, prime_contract_id, project_id, opts \\ [])
@spec rest_v10_prime_contracts_prime_contract_id_line_items_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.Default.t()]} | {:error, Tesla.Env.t()}
List Prime Contract line items Return a list of all Line Items for the Prime Contract. 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.prime_contract_id
(integer()): Prime Contract IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"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[cost_code_id]"(String.t): Cost Code ID. Returns item(s) with the specified Cost Code ID or within the specified range of Cost Code IDs. -
:"filters[line_item_type_id]"(integer()): Line Item Type ID. Returns item(s) with the specified Line Item Type ID or range of Line Item Type IDs. ### Returns -
, ...]}on success -
` on failure
rest_v10_prime_contracts_prime_contract_id_line_items_id_delete(connection, procore_company_id, prime_contract_id, id, project_id, opts \\ [])
@spec rest_v10_prime_contracts_prime_contract_id_line_items_id_delete( Tesla.Env.client(), integer(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete a Prime Contract line item Delete a Line Item from the Prime Contract.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.prime_contract_id
(integer()): Prime Contract IDid
(integer()): Line Item 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_prime_contracts_prime_contract_id_line_items_id_get(connection, procore_company_id, prime_contract_id, id, project_id, opts \\ [])
@spec rest_v10_prime_contracts_prime_contract_id_line_items_id_get( Tesla.Env.client(), integer(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Default.t()} | {:error, Tesla.Env.t()}
Show Prime Contract line item Return a specific Line Item from the Prime Contract.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.prime_contract_id
(integer()): Prime Contract IDid
(integer()): Line Item IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.Default.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_prime_contracts_prime_contract_id_line_items_id_patch(connection, procore_company_id, prime_contract_id, id, project_id, body3, opts \\ [])
@spec rest_v10_prime_contracts_prime_contract_id_line_items_id_patch( Tesla.Env.client(), integer(), integer(), integer(), integer(), Procore.Model.Body3.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Default.t()} | {:error, Tesla.Env.t()}
Update Prime Contract line item Update a Line Item from the Prime Contract. Note: A budget line item will automatically be created for Non-budgeted line items for all new projects and for projects enabled with Non-Budgeted line item beta functionality
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.prime_contract_id
(integer()): Prime Contract IDid
(integer()): Line Item IDproject_id
(integer()): Unique identifier for the project.body3
(Body3):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.Default.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_prime_contracts_prime_contract_id_line_items_post(connection, procore_company_id, prime_contract_id, project_id, body3, opts \\ [])
@spec rest_v10_prime_contracts_prime_contract_id_line_items_post( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.Body3.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Default.t()} | {:error, Tesla.Env.t()}
Create Prime Contract line item Create a new Line Item for the Prime Contract. Note: A budget line item will automatically be created for Non-budgeted line items for all new projects and for projects enabled with Non-Budgeted line item beta functionality
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.prime_contract_id
(integer()): Prime Contract IDproject_id
(integer()): Unique identifier for the project.body3
(Body3):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.Default.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_prime_contracts_prime_contract_id_line_items_sync_patch(connection, procore_company_id, prime_contract_id, project_id, line_item_sync_body1, opts \\ [])
@spec rest_v10_prime_contracts_prime_contract_id_line_items_sync_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.LineItemSyncBody1.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdLineItemsSyncPatch200Response.t()} | {:error, Tesla.Env.t()}
Sync Prime Contract Line Items Sync Prime Contract Line Items.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.prime_contract_id
(integer()): Prime Contract IDproject_id
(integer()): Unique identifier for the project.line_item_sync_body1
(LineItemSyncBody1):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdLineItemsSyncPatch200Response.t}
on success{:error, Tesla.Env.t}
on failure