List Billing Periods
list_billing_periodsRetrieve billing periods for a Procore project. Supports filtering by ID, status, and date ranges, with paginated results.
Instructions
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. Use this to enumerate Commitments when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Commitments. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Construction Financials > Commitments. Endpoint: GET /rest/v1.0/projects/{project_id}/billing_periods
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| filters__id | No | Query string parameter — return item(s) with the specified IDs. | |
| filters__created_at | No | Query string parameter — return item(s) created 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-... | |
| filters__updated_at | No | Query string parameter — 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 `YYY... | |
| filters__status | No | Query string parameter — return item(s) with the specified Billing Period status. |