Procore Time and Material Signature API

openapi: 3.2.0
info:
  title: Procore REST Time and Material Signature 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: Time and Material Signature
paths:
  /rest/v1.0/projects/{project_id}/time_and_material_entries/signatures:
    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
    post:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Create Signature for Time and Material Entry
      description: Create new Signature associated with the specified Project.
      tags:
      - Time and Material Signature
      parameters:
      - name: project_id
        in: path
        required: true
        description: Unique identifier for the project.
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              title: TimeAndMaterialSignatureCreateBody
              type: object
              required:
              - signature
              properties:
                signature:
                  type: object
                  required:
                  - party_id
                  properties:
                    data:
                      type: string
                      description: 'Attachment representing the Signature.

                        To upload an attachment, you must upload the entire payload as `multipart/form-data` content-type

                        and specify each parameter as form-data together with `data` file.'
                    party_id:
                      type: integer
                      description: ID of the party the signature is attributed to
                    signature_text:
                      type: string
                      description: Acknowledgement text the signer agreed to.
                    upload_id:
                      type: string
                      description: Upload identifier for a previously uploaded signature image.
                      example: 01JBD3HF2SA3JZ5AR107GTWF4E
        required: true
      responses:
        '201':
          description: Signature Created Succesfully
          content:
            application/json:
              schema:
                type: object
                description: Time and Material Entry Signature
                properties:
                  id:
                    type: integer
                    description: Unique identifier of the signature.
                    example: 5324
                  signature_text:
                    type: string
                    description: Acknowledgement text the signer agreed to.
                    example: I acknowledge these hours are correct.
                  file_name:
                    type: string
                    description: Filename of the signature image.
                    example: signature_2018_09_16.jpg
                  url:
                    type: string
                    description: Direct URL to the full-size signature image.
                    example: http://www.example.com/
                  medium_thumbnail_url:
                    type: string
                    description: URL for a medium-sized thumbnail of the signature image.
                    example: http://www.example.com/
                  large_thumbnail_url:
                    type: string
                    description: URL for a large-sized thumbnail of the signature image.
                    example: http://www.example.com/
                  created_at:
                    type: string
                    format: date-time
                    description: Timestamp when this signature was created, in ISO 8601 format.
                    example: '2024-03-15T06:13:10Z'
                  created_by:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Unique identifier of the user who created this signature.
                        example: 160586
                      login:
                        type: string
                        description: Email address of the user who created this signature.
                        example: carl.contractor@example.com
                      name:
                        type: string
                        description: Full name of the user who created this signature.
                        example: Carl Contractor
        '403':
          description: User does not have permission to create Signatures
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        '422':
          description: Error creating Signatures
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
      x-code-samples:
      - id: node_request
        mimeType: application/json
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'POST',\n  url: 'https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/time_and_material_entries/signatures',\n  headers: {'content-type': 'application/json'},\n  body: {\n    signature: {\n      data: 'string',\n      party_id: 0,\n      signature_text: 'string',\n      upload_id: '01JBD3HF2SA3JZ5AR107GTWF4E'\n    }\n  },\n  json: true\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
        mimeType: application/json
        title: Python3
        content: 'import http.client


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


          payload = "{\"signature\":{\"data\":\"string\",\"party_id\":0,\"signature_text\":\"string\",\"upload_id\":\"01JBD3HF2SA3JZ5AR107GTWF4E\"}}"


          headers = { ''content-type'': "application/json" }


          conn.request("POST", "/rest/v1.0/projects/%7Bproject_id%7D/time_and_material_entries/signatures", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        mimeType: application/json
        title: Curl
        content: "curl --request POST \\\n  --url https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/time_and_material_entries/signatures \\\n  --header 'content-type: application/json' \\\n  --data '{\"signature\":{\"data\":\"string\",\"party_id\":0,\"signature_text\":\"string\",\"upload_id\":\"01JBD3HF2SA3JZ5AR107GTWF4E\"}}'"
      - id: csharp_httpclient
        mimeType: application/json
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Post,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/time_and_material_entries/signatures\"),\n    Content = new StringContent(\"{\\\"signature\\\":{\\\"data\\\":\\\"string\\\",\\\"party_id\\\":0,\\\"signature_text\\\":\\\"string\\\",\\\"upload_id\\\":\\\"01JBD3HF2SA3JZ5AR107GTWF4E\\\"}}\")\n    {\n        Headers =\n        {\n            ContentType = new MediaTypeHeaderValue(\"application/json\")\n        }\n    }\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 upload_id as a new parameter for Time and Material Signature create endpoint
        description: Add upload_id as a new parameter for Time and Material Signature create endpoint
        endpoint: POST /projects/{project_id}/time_and_material_entries/signatures
        type: feature
        breaking: false
        datestamp: '2024-11-19'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: time-and-material-signature?version=1.0#create-signature-for-time-and-material-entry
      operationId: createSignatureForTimeAndMaterialEntry
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer