Procore.Api.ConstructionFinancialsCommitmentsBillingPeriods (procore_sdk v0.3.0)
API calls for all endpoints tagged ConstructionFinancialsCommitmentsBillingPeriods
.
Summary
Functions
List billing periods Return a list of all Billing Periods of a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Delete billing period Delete a specified Billing Period
Show Billing Period for Project Return information for a Billing Period
Update billing period Update a specified Billing Period
Create billing period Create a Billing Period
Functions
rest_v10_projects_project_id_billing_periods_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_billing_periods_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.BillingPeriod.t()]} | {:error, Tesla.Env.t()}
List billing periods Return a list of all Billing Periods of 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[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[status]"(String.t): Return item(s) with the specified Billing Period status. ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_billing_periods_id_delete(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_billing_periods_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 billing period Delete a specified Billing Period
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()): Billing Period IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_billing_periods_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_billing_periods_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, Procore.Model.BillingPeriod.t()} | {:error, Tesla.Env.t()}
Show Billing Period for Project Return information for a Billing Period
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()): Billing Period IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.BillingPeriod.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_billing_periods_id_patch(connection, procore_company_id, project_id, id, body146, opts \\ [])
@spec rest_v10_projects_project_id_billing_periods_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.Body146.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, Procore.Model.BillingPeriod.t()} | {:error, Tesla.Env.t()}
Update billing period Update a specified Billing Period
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()): Billing Period IDbody146
(Body146):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.BillingPeriod.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_billing_periods_post(connection, procore_company_id, project_id, body146, opts \\ [])
@spec rest_v10_projects_project_id_billing_periods_post( Tesla.Env.client(), integer(), integer(), Procore.Model.Body146.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.BillingPeriod.t()} | {:error, Tesla.Env.t()}
Create billing period Create a Billing Period
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.body146
(Body146):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.BillingPeriod.t}
on success{:error, Tesla.Env.t}
on failure