v1

latestOpenAPI 3.0.02026-07-241010520.6 KB

Utility Bills

Retrieve Utility Bill Upload Status

Retrieves the status of a utility bill upload + parse job. Use the job_id returned by the Run Utility Bill Upload endpoint.

Note that this is an asynchronous endpoint. See the Asynchronous Endpoints appendix for more info.

get/tenants/{tenant_id}/projects/{project_id}/utility_bills/status

Path parameters

tenant_idstring uuid required

The ID of the tenant that the project is part of.

project_idstring uuid required

The ID of the project the bill belongs to.

Query parameters

job_idstring uuid required

The ID of the utility bill upload job returned by the run endpoint.

Response

Job status retrieved.

Example response

{
  "utility_bill_upload_job": {
    "requested_at": "2024-07-26 15:20:31 UTC",
    "completed_at": "2024-07-26 15:20:31 UTC",
    "status": "succeeded",
    "source": "api"
  }
}