> ## Documentation Index
> Fetch the complete documentation index at: https://docs.synthetic.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an amendment

> One amendment by id. An amendment of another entity is not found. Needs a key holding `contracts:read`.



## OpenAPI

````yaml https://app.synthetic.ai/api/v1/openapi.json get /amendments/{id}
openapi: 3.1.0
info:
  title: Synthetic API
  description: Read access to your Synthetic data.
  version: 0.1.0
servers:
  - url: https://app.synthetic.ai/api/v1
security: []
paths:
  /amendments/{id}:
    get:
      tags:
        - Contracts
      summary: Get an amendment
      description: >-
        One amendment by id. An amendment of another entity is not found. Needs
        a key holding `contracts:read`.
      operationId: amendments-get
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            description: The amendment id.
          required: true
          description: The amendment id.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Amendment'
        '400':
          description: Input validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '404':
          description: The record does not exist for your business.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - BearerAuth: []
components:
  schemas:
    Amendment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        contractId:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        amendmentNumber:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            The amendment's place among the contract's amendments: 0 for the
            original terms, higher for each later one.
        status:
          type: string
          enum:
            - DRAFT
            - FINALIZING
            - FINALIZED
            - VOIDING
            - VOIDED
          description: >-
            DRAFT: being written; only a draft's terms can change. FINALIZING:
            agreed, and the contract's invoices are being updated to match.
            FINALIZED: agreed, and the invoices match. VOIDING: being withdrawn,
            and the invoices are being updated back to the terms before it.
            VOIDED: withdrawn; it no longer applies.
        type:
          type: string
          enum:
            - MODIFICATION
            - CANCELLATION
          description: >-
            MODIFICATION: changes the contract's terms from startAt.
            CANCELLATION: ends the contract on endAt. A cancellation lists the
            line items of the terms it ends, and charges for none of them.
        processingInvoices:
          type: boolean
          description: >-
            Whether the contract's invoices are still being updated after this
            amendment was finalized or voided, or the contract was deleted.
        startAt:
          format: date-time
          description: >-
            The calendar date these terms take effect, carried at UTC midnight.
            The time is not data.
          type: string
        endAt:
          format: date-time
          description: >-
            The calendar date these terms end, carried at UTC midnight: they
            cover the days before this date, not the date itself. The time is
            not data.
          type: string
        paymentTermsDays:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            How many days the customer has to pay an invoice billed under these
            terms once it is issued.
        finalizedAt:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            When the amendment became FINALIZED; null if it has not. It stays
            set if the amendment is voided later.
        voidedAt:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            When someone last asked to withdraw the amendment, which made it
            VOIDING; null if nobody has.
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - contractId
        - amendmentNumber
        - status
        - type
        - processingInvoices
        - startAt
        - endAt
        - paymentTermsDays
        - finalizedAt
        - voidedAt
        - createdAt
        - updatedAt
      additionalProperties: false
      description: >-
        A change to a contract's terms from its startAt. It holds every term
        from that date, not only the ones that change. Amendment 0 holds the
        terms the contract was created with.
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Input validation failed
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Input validation failed error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Input validation failed
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Unauthorized
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Unauthorized error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Unauthorized
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: The record does not exist for your business.
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: The record does not exist for your business. error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: The record does not exist for your business.
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: An unexpected error occurred.
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: An unexpected error occurred. error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: An unexpected error occurred.
        issues: []
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'An API key created in Settings, sent as `Authorization: Bearer <key>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.