Procore Commitment Contract Summary API

openapi: 3.2.0
info:
  title: Procore REST Commitment Contract Summary API
  version: v1.0/v2.0
  description: Merged from the per-resource OpenAPI documents Procore publishes through its developer portal (https://developers.procore.com/api/v1/resource_groups). Originals are kept verbatim in openapi/_original/resources/.
  x-source: https://developers.procore.com/api/v1/resource_groups
servers:
- url: https://api.procore.com
  description: Production
security:
- bearerAuth: []
tags:
- name: Commitment Contract Summary
paths:
  /rest/v2.0/companies/{company_id}/projects/{project_id}/commitment_contracts/{contract_id}/summary:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Show Commitment Contract Summary
      description: Returns a combined summary of change order and invoicing information for a specific commitment contract (Purchase Order or Work Order).
      tags:
      - Commitment Contract Summary
      parameters:
      - name: company_id
        in: path
        description: Unique identifier for the company.
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        description: Unique identifier for the project.
        schema:
          type: string
      - name: contract_id
        in: path
        description: ID of the Commitment Contract
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: Combined Contract Summary containing both change order and invoicing information
                    properties:
                      approved_change_total:
                        type: string
                        format: decimal
                        description: Sum of the grand totals of all approved change orders on the contract, as a decimal string. Add to the original contract value to compute the current revised contract amount.
                      approved_change_total_tax_amount:
                        type: string
                        format: decimal
                        description: Sum of the tax amounts of all approved change orders on the contract, as a decimal string.
                      pending_revised_change_total:
                        type: string
                        format: decimal
                        description: Sum of the grand totals of all pending or revised change orders on the contract, as a decimal string. Represents in-flight changes not yet approved.
                      pending_revised_change_total_tax_amount:
                        type: string
                        format: decimal
                        description: Sum of the tax amounts of all pending or revised change orders on the contract, as a decimal string.
                      draft_change_total:
                        type: string
                        format: decimal
                        description: Sum of the grand totals of all draft change orders on the contract, as a decimal string. Represents changes not yet submitted for approval.
                      draft_change_total_tax_amount:
                        type: string
                        format: decimal
                        description: Sum of the tax amounts of all draft change orders on the contract, as a decimal string.
                      total_invoices_amount:
                        type: string
                        format: decimal
                        description: Total amount billed against the contract to date across all invoices, as a decimal string. Compare against the revised contract amount to gauge billing progress.
                      total_payments_amount:
                        type: string
                        format: decimal
                        description: Total amount paid on the contract to date across all payments, as a decimal string. May trail total_invoices_amount when invoices are billed but not yet paid.
                      currency_configuration:
                        type: object
                        description: Currency configuration for the contract's financial entity.
                        properties:
                          currency_iso_code:
                            type:
                            - string
                            - 'null'
                            description: ISO 4217 currency code (e.g. USD, EUR) in which the summary amounts are expressed. Null when the financial entity has no configured currency.
                            example: USD
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: HTTP status in screaming snake case (like BAD_REQUEST)
                      message:
                        type: string
                        description: Human readable message describing error.
                      details:
                        type: array
                        description: Additional information about the error.
                        items:
                          type: object
                          required:
                          - reason_code
                          - message
                          properties:
                            reason_code:
                              type: string
                              description: A machine-readable code that identifies the error specifically enough for the client to interpret what happened and take action.
                              example: BLANK
                            message:
                              type: string
                              description: Human readable message
                              example: Name can't be blank
                            source:
                              type: string
                              description: Source of the error
                              example: name
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: HTTP status in screaming snake case (like BAD_REQUEST)
                      message:
                        type: string
                        description: Human readable message describing error.
                      details:
                        type: array
                        description: Additional information about the error.
                        items:
                          type: object
                          required:
                          - reason_code
                          - message
                          properties:
                            reason_code:
                              type: string
                              description: A machine-readable code that identifies the error specifically enough for the client to interpret what happened and take action.
                              example: BLANK
                            message:
                              type: string
                              description: Human readable message
                              example: Name can't be blank
                            source:
                              type: string
                              description: Source of the error
                              example: name
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: HTTP status in screaming snake case (like BAD_REQUEST)
                      message:
                        type: string
                        description: Human readable message describing error.
                      details:
                        type: array
                        description: Additional information about the error.
                        items:
                          type: object
                          required:
                          - reason_code
                          - message
                          properties:
                            reason_code:
                              type: string
                              description: A machine-readable code that identifies the error specifically enough for the client to interpret what happened and take action.
                              example: BLANK
                            message:
                              type: string
                              description: Human readable message
                              example: Name can't be blank
                            source:
                              type: string
                              description: Source of the error
                              example: name
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: HTTP status in screaming snake case (like BAD_REQUEST)
                      message:
                        type: string
                        description: Human readable message describing error.
                      details:
                        type: array
                        description: Additional information about the error.
                        items:
                          type: object
                          required:
                          - reason_code
                          - message
                          properties:
                            reason_code:
                              type: string
                              description: A machine-readable code that identifies the error specifically enough for the client to interpret what happened and take action.
                              example: BLANK
                            message:
                              type: string
                              description: Human readable message
                              example: Name can't be blank
                            source:
                              type: string
                              description: Source of the error
                              example: name
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'https://api.procore.com/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/commitment_contracts/%7Bcontract_id%7D/summary'\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - id: python_python3
        title: Python3
        content: 'import http.client


          conn = http.client.HTTPSConnection("api.procore.com")


          conn.request("GET", "/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/commitment_contracts/%7Bcontract_id%7D/summary")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request GET \\\n  --url https://api.procore.com/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/commitment_contracts/%7Bcontract_id%7D/summary"
      - id: csharp_httpclient
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Get,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/commitment_contracts/%7Bcontract_id%7D/summary\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n    response.EnsureSuccessStatusCode();\n    var body = await response.Content.ReadAsStringAsync();\n    Console.WriteLine(body);\n}"
      x-rate-limit-enabled: true
      x-procore-kong-tags:
      - rate-limit:enabled
      x-changelog:
      - summary: Add change order tax totals
        description: Adds approved_change_total_tax_amount, pending_revised_change_total_tax_amount, and draft_change_total_tax_amount to the combined contract summary.
        endpoint: GET /companies/{company_id}/projects/{project_id}/commitment_contracts/{contract_id}/summary
        type: refinement
        breaking: false
        datestamp: '2026-07-21'
        versions:
        - '2.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: commitment-contract-summary?version=2.0#show-commitment-contract-summary
      operationId: showCommitmentContractSummary
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer