Procore.Api.ConstructionFinancialsCommitmentsRequisitionsSubcontractorInvoices (procore_sdk v0.3.0)
API calls for all endpoints tagged ConstructionFinancialsCommitmentsRequisitionsSubcontractorInvoices
.
Summary
Functions
List Requisitions (Subcontractor Invoices) for Project Return a list of Requisitions (Subcontractor Invoices) on a specified project See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Delete Requisition (Subcontractor Invoice) Delete specified Requisition (Subcontractor Invoice)
Show Requisition (Subcontractor Invoice) Return a Requisition (Subcontractor Invoice) on a specified Project
Update Requisition (Subcontractor Invoice) Update a specified Requisition (Subcontractor Invoice). Users without admin permissions can only update a requisition (sub invoice) if it is the most recent and has a status of 'draft' or 'revise_and_resubmit'. Users with admin permissions can update a requisition (sub invoice) regardless of its status or whether it is the most recent.
Create Requisition (Subcontractor Invoices) for Commitment Create a new Requisition (Subcontractor Invoices) for the specified Commitment
Add Change Order Package to a Requisition (Subcontractor Invoice) The Add Change Order Package endpoint allows for the addition of a Change Order Package to a Requisition (Subcontractor Invoice) which will cause change_order_items to be added to the Requisition (Subcontractor Invoice)
Show Detail for Requisition (Subcontractor Invoice) Return Requisition (Subcontractor Invoice) Detail
Remove Change Order Package from a Requisition (Subcontractor Invoice) Remove a specified Change Order Package from a Requisition (Subcontractor Invoice)
List Requisitions (Subcontractor Invoices) for Project Return a list of Requisitions (Subcontractor Invoices) on a specified project See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Delete Requisition (Subcontractor Invoice) Delete specified Requisition (Subcontractor Invoice)
Show Requisition (Subcontractor Invoice) Return a Requisition (Subcontractor Invoice) on a specified Project
Update Requisition (Subcontractor Invoice) Update a specified Requisition (Subcontractor Invoice). Users without admin permissions can only update a requisition (sub invoice) if it is the most recent and has a status of 'draft' or 'revise_and_resubmit'. Users with admin permissions can update a requisition (sub invoice) regardless of its status or whether it is the most recent. Requisition items are optional.
Create Requisition (Subcontractor Invoices) for Commitment Create a new Requisition (Subcontractor Invoices) for the specified Commitment
Update the Due Date for a Requisition (Subcontractor Invoice) Updates the Due Date for a Requisition (Subcontractor Invoice)
Functions
rest_v10_requisitions_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_requisitions_get(Tesla.Env.client(), integer(), integer(), keyword()) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10RequisitionsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List Requisitions (Subcontractor Invoices) for Project Return a list of Requisitions (Subcontractor Invoices) on a specified 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.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[commitment_id]"
(integer()): Commitment ID(s). Returns item(s) with the specified Commitment ID(s).:"filters[period_id]"
(integer()): Billing Period ID. Returns item(s) with the specified Billing Period ID.:"filters[status]"
(String.t): Return item(s) with the specified Requisition (Subcontractor Invoice) 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[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. ### Returns -
, ...]}on success -
` on failure
rest_v10_requisitions_id_delete(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_requisitions_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Delete Requisition (Subcontractor Invoice) Delete specified Requisition (Subcontractor Invoice)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Requisition (Subcontractor Invoice) 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_requisitions_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_requisitions_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10RequisitionsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Show Requisition (Subcontractor Invoice) Return a Requisition (Subcontractor Invoice) on a specified Project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Requisition (Subcontractor Invoice) IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10RequisitionsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_requisitions_id_patch(connection, procore_company_id, id, body22, opts \\ [])
@spec rest_v10_requisitions_id_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.Body22.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Update Requisition (Subcontractor Invoice) Update a specified Requisition (Subcontractor Invoice). Users without admin permissions can only update a requisition (sub invoice) if it is the most recent and has a status of 'draft' or 'revise_and_resubmit'. Users with admin permissions can update a requisition (sub invoice) regardless of its status or whether it is the most recent.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Requisition (Subcontractor Invoice) IDbody22
(Body22):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_requisitions_post(connection, procore_company_id, body22, opts \\ [])
@spec rest_v10_requisitions_post( Tesla.Env.client(), integer(), Procore.Model.Body22.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Create Requisition (Subcontractor Invoices) for Commitment Create a new Requisition (Subcontractor Invoices) for the specified Commitment
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.body22
(Body22):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_requisitions_requisition_id_add_change_order_package_post(connection, procore_company_id, requisition_id, commitment_id, project_id, change_order_package_id, opts \\ [])
@spec rest_v10_requisitions_requisition_id_add_change_order_package_post( Tesla.Env.client(), integer(), integer(), integer(), integer(), integer(), keyword() ) :: {:ok, [ Procore.Model.RestV10RequisitionsRequisitionIdAddChangeOrderPackagePost201ResponseInner.t() ]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Add Change Order Package to a Requisition (Subcontractor Invoice) The Add Change Order Package endpoint allows for the addition of a Change Order Package to a Requisition (Subcontractor Invoice) which will cause change_order_items to be added to the Requisition (Subcontractor Invoice)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.requisition_id
(integer()): Requisition (Subcontractor Invoice) IDcommitment_id
(integer()): Commitment IDproject_id
(integer()): Unique identifier for the project.change_order_package_id
(integer()): Change Order Package IDopts
(keyword): Optional parameters
Returns
{:ok, [%RestV10RequisitionsRequisitionIdAddChangeOrderPackagePost201ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_requisitions_requisition_id_detail_get(connection, procore_company_id, requisition_id, project_id, opts \\ [])
@spec rest_v10_requisitions_requisition_id_detail_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, [ Procore.Model.RestV10RequisitionsRequisitionIdDetailGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
Show Detail for Requisition (Subcontractor Invoice) Return Requisition (Subcontractor Invoice) Detail
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.requisition_id
(integer()): Requisition (Subcontractor Invoice) IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, [%RestV10RequisitionsRequisitionIdDetailGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_requisitions_requisition_id_remove_change_order_package_delete(connection, procore_company_id, requisition_id, commitment_id, project_id, change_order_package_id, opts \\ [])
@spec rest_v10_requisitions_requisition_id_remove_change_order_package_delete( Tesla.Env.client(), integer(), integer(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Remove Change Order Package from a Requisition (Subcontractor Invoice) Remove a specified Change Order Package from a Requisition (Subcontractor Invoice)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.requisition_id
(integer()): Requisition (Subcontractor Invoice) IDcommitment_id
(integer()): Commitment IDproject_id
(integer()): Unique identifier for the project.change_order_package_id
(integer()): Change Order Package IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v11_requisitions_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v11_requisitions_get(Tesla.Env.client(), integer(), integer(), keyword()) :: {:ok, [Procore.Model.RestV11RequisitionsGet200ResponseInner.t()]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
List Requisitions (Subcontractor Invoices) for Project Return a list of Requisitions (Subcontractor Invoices) on a specified 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.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[commitment_id]"
(integer()): Commitment ID(s). Returns item(s) with the specified Commitment ID(s).:"filters[period_id]"
(integer()): Billing Period ID. Returns item(s) with the specified Billing Period ID.:"filters[status]"
(String.t): Return item(s) with the specified Requisition (Subcontractor Invoice) 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 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
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC Offset:"filters[origin_id]"
(String.t): Origin ID. Returns item(s) with the specified Origin ID.:"filters[is_last]"
(boolean()): Setting this to true will return only the last item. Setting this to false will return all the items except the last one.:view
(String.t): Specifies which view (which attributes) of the resource is going to be present in the response.
Returns
{:ok, [%RestV11RequisitionsGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v11_requisitions_id_delete(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v11_requisitions_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Delete Requisition (Subcontractor Invoice) Delete specified Requisition (Subcontractor Invoice)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Requisition (Subcontractor Invoice) IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v11_requisitions_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v11_requisitions_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Show Requisition (Subcontractor Invoice) Return a Requisition (Subcontractor Invoice) on a specified Project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Requisition (Subcontractor Invoice) IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:view
(String.t): Specifies which view (which attributes) of the resource is going to be present in the response.
Returns
{:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_requisitions_id_patch(connection, procore_company_id, id, body21, opts \\ [])
@spec rest_v11_requisitions_id_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.Body21.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Update Requisition (Subcontractor Invoice) Update a specified Requisition (Subcontractor Invoice). Users without admin permissions can only update a requisition (sub invoice) if it is the most recent and has a status of 'draft' or 'revise_and_resubmit'. Users with admin permissions can update a requisition (sub invoice) regardless of its status or whether it is the most recent. Requisition items are optional.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Requisition (Subcontractor Invoice) IDbody21
(Body21):opts
(keyword): Optional parameters:view
(String.t): Specifies which view (which attributes) of the resource is going to be present in the response.
Returns
{:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_requisitions_post(connection, procore_company_id, body20, opts \\ [])
@spec rest_v11_requisitions_post( Tesla.Env.client(), integer(), Procore.Model.Body20.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Create Requisition (Subcontractor Invoices) for Commitment Create a new Requisition (Subcontractor Invoices) for the specified Commitment
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.body20
(Body20):opts
(keyword): Optional parameters:view
(String.t): Specifies which view (which attributes) of the resource is going to be present in the response.:invite_id
(integer()): Unique identifier for the invite to associate with the requisition.
Returns
{:ok, Procore.Model.RestV11RequisitionsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v20_companies_company_id_projects_project_id_requisitions_id_payment_details_patch(connection, procore_company_id, company_id, project_id, id, payment_due_date, opts \\ [])
@spec rest_v20_companies_company_id_projects_project_id_requisitions_id_payment_details_patch( Tesla.Env.client(), integer(), String.t(), String.t(), String.t(), Procore.Model.PaymentDueDate.t(), keyword() ) :: {:ok, Procore.Model.RestV20CompaniesCompanyIdProjectsProjectIdRequisitionsIdPaymentDetailsPatch200Response.t()} | {:ok, Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()} | {:error, Tesla.Env.t()}
Update the Due Date for a Requisition (Subcontractor Invoice) Updates the Due Date for a Requisition (Subcontractor Invoice)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(String.t): Unique identifier for the company.project_id
(String.t): Unique identifier for the project.id
(String.t): Unique identifier for the Requisition (Subcontractor Invoice)payment_due_date
(PaymentDueDate):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV20CompaniesCompanyIdProjectsProjectIdRequisitionsIdPaymentDetailsPatch200Response.t}
on success{:error, Tesla.Env.t}
on failure