openapi: 3.1.0
info:
  title: Agave Unified Construction API (derived from the provider Postman collection)
  version: '2021-11-21'
  description: Machine-readable OpenAPI DERIVED by API Evangelist from the Postman collection Agave publishes at
    https://docs.agaveapi.com/agave-api/postman-collection (AgaveAPI-2024-09-10.zip, collection exported 2024-09-10,
    437 requests). Agave publishes no OpenAPI of its own; this document is a faithful projection of the requests
    in that collection and nothing more — request/response schemas beyond the collection's own examples are NOT
    modelled, and no operation here was invented. The verbatim collection is kept at collections/agave-api-provider.postman_collection.json.
  contact:
    name: Agave API Support
    email: api-support@agaveapi.com
    url: https://docs.agaveapi.com
  x-derived-from: collections/agave-api-provider.postman_collection.json
  x-method: derived
  x-generated: '2026-08-30'
servers:
- url: https://api.agaveapi.com
  description: Production
security:
- ClientId: []
  ClientSecret: []
  AccountToken: []
tags:
- name: Common
  description: Common resources in the Agave unified construction API.
- name: Customer Management
  description: Customer Management resources in the Agave unified construction API.
- name: File Management
  description: File Management resources in the Agave unified construction API.
- name: Financials Management
  description: Financials Management resources in the Agave unified construction API.
- name: Project Management
  description: Project Management resources in the Agave unified construction API.
- name: Service Management
  description: Service Management resources in the Agave unified construction API.
- name: Webhooks
  description: Webhooks resources in the Agave unified construction API.
paths:
  /ping:
    get:
      operationId: getPing
      summary: Enable
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/token/create:
    post:
      operationId: postLinkTokenCreate
      summary: Create
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /link/token/exchange:
    post:
      operationId: postLinkTokenExchange
      summary: Exchange
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              public_token: iaZytJMCQnfkEfOfHXL1eNAdRbor2UjoBQFt8x6U
  /link/sessions:
    post:
      operationId: postLinkSessions
      summary: Create (Mode)
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: test session
              ttl: '21600'
              mode: file-picker
    get:
      operationId: getLinkSessions
      summary: List
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /link/sessions/xxx/extend:
    post:
      operationId: postLinkSessionsXxxExtend
      summary: Extend
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /link/sessions/xxx/expire:
    post:
      operationId: postLinkSessionsXxxExpire
      summary: Expire
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /link/account:
    get:
      operationId: getLinkAccount
      summary: Linked Account
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/edit:
    post:
      operationId: postLinkEdit
      summary: Edit Link
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /link/source-system:
    get:
      operationId: getLinkSourceSystem
      summary: Source System
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/source-systems:
    get:
      operationId: getLinkSourceSystems
      summary: Source Systems
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/connection:
    get:
      operationId: getLinkConnection
      summary: Connection
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/rate-limits:
    get:
      operationId: getLinkRateLimits
      summary: Rate Limits
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/company:
    get:
      operationId: getLinkCompany
      summary: Linked Company
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/companies:
    get:
      operationId: getLinkCompanies
      summary: List All Companies
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/user:
    get:
      operationId: getLinkUser
      summary: Linked User
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /link/account/create:
    post:
      operationId: postLinkAccountCreate
      summary: Create OAuth2 Account
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: xxxxx-from-postman
              source_system: pipedrive
              connection:
                type: oauth2
                properties:
                  grant_type: authorization_code
                  code: xxxxxxxx
  /link/debug/session:
    post:
      operationId: postLinkDebugSession
      summary: Create Debug Session
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: xxx-ref
              source_system: foundation-hosted
  /link/revoke-tokens:
    post:
      operationId: postLinkRevokeTokens
      summary: Revoke All Tokens
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /async-requests/{async_request_id}:
    get:
      operationId: getAsyncRequestsByAsyncRequestId
      summary: Get Async Request
      tags:
      - Common
      parameters:
      - name: async_request_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the async request.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /admin/accounts/{id}:
    get:
      operationId: getAdminAccountsById
      summary: Show Account
      tags:
      - Common
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the id.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /admin/accounts/{id}/sessions:
    get:
      operationId: getAdminAccountsByIdSessions
      summary: List Account Sessions
      tags:
      - Common
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the id.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /admin/accounts/{id}/events:
    get:
      operationId: getAdminAccountsByIdEvents
      summary: List Account Events
      tags:
      - Common
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the id.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /admin/accounts/{id}/requests:
    get:
      operationId: getAdminAccountsByIdRequests
      summary: List Account Requests
      tags:
      - Common
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the id.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /admin/accounts:
    get:
      operationId: getAdminAccounts
      summary: List Accounts
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /admin/link-tokens:
    get:
      operationId: getAdminLinkTokens
      summary: Link Tokens
      tags:
      - Common
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              reference_id: user-12345
  /admin/accounts/{id}/revoke-tokens:
    post:
      operationId: postAdminAccountsByIdRevokeTokens
      summary: Revoke All Tokens For Account
      tags:
      - Common
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the id.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /cache/repopulate:
    post:
      operationId: postCacheRepopulate
      summary: Cache
      tags:
      - Common
      parameters:
      - name: type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /cache/{cache_id}:
    get:
      operationId: getCacheByCacheId
      summary: Cache Status
      tags:
      - Common
      parameters:
      - name: cache_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cache.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /cache/repopulate/latest:
    get:
      operationId: getCacheRepopulateLatest
      summary: Cache Latest Status
      tags:
      - Common
      parameters:
      - name: type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /assets:
    get:
      operationId: getAssets
      summary: List Assets
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postAssets
      summary: New Asset
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              category: EQUIPMENT
              current_location_id: '*'
              default_location_id: 001-NY
              description: Ford F250 Pickup Truck
              make: Ford
              manufacturer: null
              model: F250
              name: FORD F250 PICKUP Test
              number: '100024696'
              ownership_type: null
              serial_number: S8XEE906
              status: Active
              type: '1000'
              vendor_id: 00a46e09-d013-5818-9bb6-871f0953148f
              source_data:
                EmeHomelocName: New York Yard / Warehouse
                EmeBulkEquipmentFlag: Y
                EmeAutoChargeoutFlag: Y
                EmeEqpHier: A126
                EmeBillRateRequiredFlag: N
                EmeFixedAssetsFlag: Y
                EmeDepreciationFlag: N
                EmeUseMeterReadingFlag: N
  /assets/{asset_id}:
    get:
      operationId: getAssetsByAssetId
      summary: Show Asset
      tags:
      - Financials Management
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the asset.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putAssetsByAssetId
      summary: Update Asset
      tags:
      - Financials Management
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the asset.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              category: EQUIPMENT
              current_location_id: '*'
              default_location_id: 001-NY
              description: Ford F250 Pickup Truck
              make: Ford
              manufacturer: null
              model: F250
              name: FORD F250 PICKUP
              number: '1000245'
              ownership_type: null
              serial_number: S8XEE769789
              status: Active
              type: '1000'
              source_data:
                EmeHomelocName: New York Yard / Warehouse
                EmeBulkEquipmentFlag: Y
                EmeAutoChargeoutFlag: Y
                EmeEqpHier: '999'
                EmeBillRateRequiredFlag: N
                EmeFloatFlag: N
                EmeFixedAssetsFlag: Y
                EmeDepreciationFlag: N
                EmeUseMeterReadingFlag: N
  /ap-invoices:
    get:
      operationId: getApInvoices
      summary: List AP Invoices
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postApInvoices
      summary: New AP Invoice
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              type: Voucher
              issue_date: '2024-03-02'
              vendor_id: '{{vendor_id}}'
              contract:
                id: '{{subcontract_id}}'
                type: subcontract
              number: sz-001
              line_items:
              - amount: '10'
                quantity: '0'
                contract:
                  id: '{{subcontract_id}}'
                  line_item_id: '{{subcontract_line_item_id}}'
  /ap-invoices/{ap_invoice_id}:
    get:
      operationId: getApInvoicesByApInvoiceId
      summary: Show AP Invoice
      tags:
      - Financials Management
      parameters:
      - name: ap_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putApInvoicesByApInvoiceId
      summary: Update AP Invoice
      tags:
      - Financials Management
      parameters:
      - name: ap_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: apple
              due_date: '2023-05-11'
              issue_date: '2023-04-11'
              number: '3'
    delete:
      operationId: deleteApInvoicesByApInvoiceId
      summary: Delete AP Invoice
      tags:
      - Financials Management
      parameters:
      - name: ap_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ap-invoices/{ap_invoice_id}/line-items:
    get:
      operationId: getApInvoicesByApInvoiceIdLineItems
      summary: List AP Invoice Line Items
      tags:
      - Financials Management
      parameters:
      - name: ap_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postApInvoicesByApInvoiceIdLineItems
      summary: New AP Invoice Line Item
      tags:
      - Financials Management
      parameters:
      - name: ap_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '1.3'
              description: test item
              quantity: '1.0'
              unit_cost: '1.3'
              type: AccountBasedExpenseLineDetail
              customer_id: '{{customer_id}}'
              status: NotBillable
  /ap-invoices/{ap_invoice_id}/line-items/{ap_invoice_line_item_id}:
    get:
      operationId: getApInvoicesByApInvoiceIdLineItemsByApInvoiceLineItemId
      summary: Show AP Invoice Line Item
      tags:
      - Financials Management
      parameters:
      - name: ap_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice.
      - name: ap_invoice_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putApInvoicesByApInvoiceIdLineItemsByApInvoiceLineItemId
      summary: Update AP Invoice Line Item
      tags:
      - Financials Management
      parameters:
      - name: ap_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice.
      - name: ap_invoice_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              discount_amount: '{{$randomInt}}'
    delete:
      operationId: deleteApInvoicesByApInvoiceIdLineItemsByApInvoiceLineItemId
      summary: Delete AP Invoice Line Item
      tags:
      - Financials Management
      parameters:
      - name: ap_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice.
      - name: ap_invoice_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap invoice line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ap-payments:
    get:
      operationId: getApPayments
      summary: List AP Payments
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postApPayments
      summary: New AP Payment
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              bank_account_id: source_id:35
              description: Test AP Payment
              number: PA-013-PAY
              payment_date: '2024-01-01'
              payment_method: Check
              total_amount: '10.00'
              vendor_id: source_id:10
              line_items:
              - ap_invoice_id: '{{ap_invoice_id}}'
                discount_taken_amount: null
                total_amount: '5.00'
  /ap-payments/{ap_payment_id}:
    get:
      operationId: getApPaymentsByApPaymentId
      summary: Show AP Payment
      tags:
      - Financials Management
      parameters:
      - name: ap_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putApPaymentsByApPaymentId
      summary: Update AP Payment
      tags:
      - Financials Management
      parameters:
      - name: ap_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: apple
              due_date: 2/2/22
              issue_date: 1/1/11
              number: '3'
              vendor_id: 82be2b68-5e42-5e04-b54d-4ceafc8eea92
              line_items:
              - amount: 103
                description: newnew2
                quantity: 203
                status: Billable
                type: AccountBasedExpenseLineDetail
                unit_cost: 303
                account_id: e6254e11-d683-5b14-95ba-47bd37aefa17
                item_id: bdbb5e32-502e-525b-a98d-d6e461a0fad2
                customer_id: 9e46c938-6ffc-5841-b37d-b2589ce437fb
    delete:
      operationId: deleteApPaymentsByApPaymentId
      summary: Delete AP Payment
      tags:
      - Financials Management
      parameters:
      - name: ap_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ap-payments/{ap_payment_id}/line-items:
    get:
      operationId: getApPaymentsByApPaymentIdLineItems
      summary: List AP Payment Line Items
      tags:
      - Financials Management
      parameters:
      - name: ap_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postApPaymentsByApPaymentIdLineItems
      summary: New AP Payment Line Item
      tags:
      - Financials Management
      parameters:
      - name: ap_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              ap_invoice_id: source_id:454800
              total_amount: '600.00'
  /ap-payments/{ap_payment_id}/line-items/{ap_payment_line_item_id}:
    get:
      operationId: getApPaymentsByApPaymentIdLineItemsByApPaymentLineItemId
      summary: Show AP Payment Line Item
      tags:
      - Financials Management
      parameters:
      - name: ap_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment.
      - name: ap_payment_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment line item.
      - name: contract_id
        in: query
        required: false
        schema:
          type: string
      - name: contract_type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putApPaymentsByApPaymentIdLineItemsByApPaymentLineItemId
      summary: Update AP Payment Line Item
      tags:
      - Financials Management
      parameters:
      - name: ap_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment.
      - name: ap_payment_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: 100
              description: Two tons of cement!
              quantity: null
              status: Billable
              type: AccountBasedExpenseLineDetail
              unit_cost: null
              ledger_account_id: c0d61b50-1e58-5844-86aa-c4f42a601808
              item_id: null
              customer_id: 693f8cb6-f10e-5c6b-a4c8-6e2dbe738d8c
    delete:
      operationId: deleteApPaymentsByApPaymentIdLineItemsByApPaymentLineItemId
      summary: Delete AP Payment Line Item
      tags:
      - Financials Management
      parameters:
      - name: ap_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment.
      - name: ap_payment_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ap payment line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ar-invoices:
    get:
      operationId: getArInvoices
      summary: List AR Invoices
      tags:
      - Financials Management
      parameters:
      - name: filters[]
        in: query
        required: false
        schema:
          type: string
      - name: filters[]
        in: query
        required: false
        schema:
          type: string
      - name: filters[]
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postArInvoices
      summary: New AR Invoice
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              batch: '10916'
              customer_id: source_id:3507331
              issue_date: '2024-08-05'
              number: '357'
              tax_code_id: source_id:1900
              department_id: source_id:1
              line_items:
                amount:
                - '50'
  /ar-invoices/{ar_invoice_id}:
    get:
      operationId: getArInvoicesByArInvoiceId
      summary: Show AR Invoice
      tags:
      - Financials Management
      parameters:
      - name: ar_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putArInvoicesByArInvoiceId
      summary: Update AR Invoice
      tags:
      - Financials Management
      parameters:
      - name: ar_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              due_date: '2023-05-12'
              issue_date: '2023-04-11'
    delete:
      operationId: deleteArInvoicesByArInvoiceId
      summary: Delete AR Invoice
      tags:
      - Financials Management
      parameters:
      - name: ar_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ar-invoices/{ar_invoice_id}/line-items:
    get:
      operationId: getArInvoicesByArInvoiceIdLineItems
      summary: List AR Invoice Line Items
      tags:
      - Financials Management
      parameters:
      - name: ar_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postArInvoicesByArInvoiceIdLineItems
      summary: New AR Invoice Line Item
      tags:
      - Financials Management
      parameters:
      - name: ar_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: 337db147-8267-56de-8d84-8785fb789069
              unit_of_measure: $
              source_data:
                ScschVenCode: '3456'
                ScschChgCode: '000'
                ScschCatCode: M
                ScschTaskCode: '1'
  /ar-invoices/{ar_invoice_id}/line-items/{ar_invoice_line_item_id}:
    get:
      operationId: getArInvoicesByArInvoiceIdLineItemsByArInvoiceLineItemId
      summary: Show AR Invoice Line Item
      tags:
      - Financials Management
      parameters:
      - name: ar_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice.
      - name: ar_invoice_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putArInvoicesByArInvoiceIdLineItemsByArInvoiceLineItemId
      summary: Update AR Invoice Line Item
      tags:
      - Financials Management
      parameters:
      - name: ar_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice.
      - name: ar_invoice_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: 337db147-8267-56de-8d84-8785fb789069
              unit_of_measure: $
    delete:
      operationId: deleteArInvoicesByArInvoiceIdLineItemsByArInvoiceLineItemId
      summary: Delete AR Invoice Line Item
      tags:
      - Financials Management
      parameters:
      - name: ar_invoice_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice.
      - name: ar_invoice_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar invoice line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              actual_completion_date: '2022-08-25'
              contractor_id: '{{vendor_id}}'
              defects_expiry_date: '2022-08-27'
              defects_period: ''
              description: Contract by Pooria via Agave 5
              estimated_completion_date: '2022-08-27'
              execution_date: '2022-05-27'
              full_release_date: '2022-02-27'
              half_release_date: '2022-08-27'
              is_executed: true
              retainage_percent: 25
              retention_based_on: Unknown
              sent_date: '2022-01-01'
              start_date: '2022-01-02'
              total_amount: ''
              type: Lump Sum
  /ar-payments:
    get:
      operationId: getArPayments
      summary: List AR Payments
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postArPayments
      summary: New AR Payment
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: 25
              batch: '1'
              number: abcdef245
              customer_id: '{{customer_id}}'
              type: AR PAYMENTS
              line_items:
              - amount: 25
                ar_invoice_id: '{{ar_invoice_id}}'
                type: Invoice
                discount_taken_amount: 1
  /ar-payments/{ar_payment_id}:
    get:
      operationId: getArPaymentsByArPaymentId
      summary: Show AR Payment
      tags:
      - Financials Management
      parameters:
      - name: ar_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putArPaymentsByArPaymentId
      summary: Update AR  Payment
      tags:
      - Financials Management
      parameters:
      - name: ar_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: 123
              customer_id: '{{customer_id}}'
              memo: some memo
              transaction_date: 1/1/11
              line_items:
              - amount: 123
                ar_invoice_id: '{{invoice_id}}'
    delete:
      operationId: deleteArPaymentsByArPaymentId
      summary: Delete AR  Payment
      tags:
      - Financials Management
      parameters:
      - name: ar_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ar-payments/{ar_payment_id}/line-items:
    get:
      operationId: getArPaymentsByArPaymentIdLineItems
      summary: List AR Payment Line Items
      tags:
      - Financials Management
      parameters:
      - name: ar_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postArPaymentsByArPaymentIdLineItems
      summary: New AR Payment Line Item
      tags:
      - Financials Management
      parameters:
      - name: ar_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: 337db147-8267-56de-8d84-8785fb789069
              unit_of_measure: $
              source_data:
                ScschVenCode: '3456'
                ScschChgCode: '000'
                ScschCatCode: M
                ScschTaskCode: '1'
  /ar-payments/{ar_payment_id}/line-items/{ar_payment_line_item_id}:
    get:
      operationId: getArPaymentsByArPaymentIdLineItemsByArPaymentLineItemId
      summary: Show AR Payment Line Item
      tags:
      - Financials Management
      parameters:
      - name: ar_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment.
      - name: ar_payment_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              actual_completion_date: '2022-08-25'
              contractor_id: '{{vendor_id}}'
              defects_expiry_date: '2022-08-27'
              defects_period: ''
              description: Contract by Pooria via Agave 5
              estimated_completion_date: '2022-08-27'
              execution_date: '2022-05-27'
              full_release_date: '2022-02-27'
              half_release_date: '2022-08-27'
              is_executed: true
              retainage_percent: 25
              retention_based_on: Unknown
              sent_date: '2022-01-01'
              start_date: '2022-01-02'
              total_amount: ''
              type: Lump Sum
    put:
      operationId: putArPaymentsByArPaymentIdLineItemsByArPaymentLineItemId
      summary: Update AR  Line Item
      tags:
      - Financials Management
      parameters:
      - name: ar_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment.
      - name: ar_payment_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: 337db147-8267-56de-8d84-8785fb789069
              unit_of_measure: $
    delete:
      operationId: deleteArPaymentsByArPaymentIdLineItemsByArPaymentLineItemId
      summary: Delete AR  Payment Line Item
      tags:
      - Financials Management
      parameters:
      - name: ar_payment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment.
      - name: ar_payment_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ar payment line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              actual_completion_date: '2022-08-25'
              contractor_id: '{{vendor_id}}'
              defects_expiry_date: '2022-08-27'
              defects_period: ''
              description: Contract by Pooria via Agave 5
              estimated_completion_date: '2022-08-27'
              execution_date: '2022-05-27'
              full_release_date: '2022-02-27'
              half_release_date: '2022-08-27'
              is_executed: true
              retainage_percent: 25
              retention_based_on: Unknown
              sent_date: '2022-01-01'
              start_date: '2022-01-02'
              total_amount: ''
              type: Lump Sum
  /bank-accounts:
    get:
      operationId: getBankAccounts
      summary: List Bank Accounts
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /bank-accounts/{bank_account_id}:
    get:
      operationId: getBankAccountsByBankAccountId
      summary: Show Bank Account
      tags:
      - Financials Management
      parameters:
      - name: bank_account_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the bank account.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /batches:
    get:
      operationId: getBatches
      summary: List Batches
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postBatches
      summary: New Batch
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              type: Timecard Entry
              source_data:
                Mth: '2024-01-01 00:00:00'
  /batches/{batch_id}:
    get:
      operationId: getBatchesByBatchId
      summary: Show Batch
      tags:
      - Financials Management
      parameters:
      - name: batch_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the batch.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putBatchesByBatchId
      summary: Update Batch
      tags:
      - Financials Management
      parameters:
      - name: batch_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the batch.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              status: Posted
  /budget-line-items:
    get:
      operationId: getBudgetLineItems
      summary: List Budget Line Items
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postBudgetLineItems
      summary: New Budget Line Item
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_type_id: source_id:Labor
              cost_code_id: source_id:02
              quantity: '1'
              unit_cost: '1250'
              original_amount: '1250'
    patch:
      operationId: patchBudgetLineItems
      summary: Bulk Write Budget Line Items
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              creates:
              - cost_code_id: 'source_id:      1000'
                cost_type_id: 'source_id:    8'
                original_amount: '100'
                quantity: '13'
                sub_job_id: 'source_id:      1000'
                unit_of_measure: lb
              - cost_code_id: 'source_id:      1000'
                cost_type_id: 'source_id:    8'
                original_amount: '10'
                quantity: '10'
                sub_job_id: 'source_id:         1'
                unit_of_measure: ea
              - cost_code_id: 'source_id:       2070'
                cost_type_id: 'source_id:    7'
                sub_job_id: 'source_id:      1000'
                unit_of_measure: conflict 1
              - cost_code_id: 'source_id:       2070'
                cost_type_id: 'source_id:    8'
                sub_job_id: 'source_id:      1000'
                unit_of_measure: conflict 2
              - cost_code_id: 'source_id:      1000'
                cost_type_id: 'source_id:    7'
                sub_job_id: 'source_id:      1000'
              - cost_code_id: 'source_id:      1000'
                cost_type_id: 'source_id:    0'
                sub_job_id: 'source_id:      1000'
              updates:
              - id: source_id:cost_code_no=      1000|cost_class_no=    7|phase_no=      1000
                original_amount: '200'
                quantity: '26'
                unit_of_measure: lb
              - id: source_id:cost_code_no=         1|cost_class_no=    1|phase_no=      1000
                original_amount: '20'
                quantity: '20'
                unit_of_measure: ea
              - id: cost_code_no=      2070|cost_class_no=    2|phase_no=      2000
                unit_of_measure: conflict 3
              - id: source_id:cost_code_no=      1000|cost_class_no=    8|phase_no=      1000
  /budget-line-items/{budget_line_item_id}:
    get:
      operationId: getBudgetLineItemsByBudgetLineItemId
      summary: Show Budget Line Item
      tags:
      - Financials Management
      parameters:
      - name: budget_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putBudgetLineItemsByBudgetLineItemId
      summary: Update Budget Line Item
      tags:
      - Financials Management
      parameters:
      - name: budget_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_type_id: source_id:520793
              cost_code_id: source_id:61
              quantity: '10'
              unit_cost: '1300'
    delete:
      operationId: deleteBudgetLineItemsByBudgetLineItemId
      summary: Delete Budget Line Item
      tags:
      - Financials Management
      parameters:
      - name: budget_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /budget-transfers:
    get:
      operationId: getBudgetTransfers
      summary: List Budget Transfers
      tags:
      - Financials Management
      parameters:
      - name: expand
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postBudgetTransfers
      summary: New Budget Transfer
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: 'Budget Transfer via API #3'
              line_items:
              - origin_budget_line_item:
                  id: source_id:Phase=012168-30-1021|CostType=1
                  amount: '-1500.00'
                  quantity: '3.0'
                  unit_cost: '-500'
                target_budget_line_item:
                  id: source_id:Phase=012516-05-1015|CostType=5
                  amount: '1500.00'
                  quantity: '1.000'
                  unit_cost: '1500.00000'
              source_data:
                ApprovalDate: '2024-02-22 00:00:00'
  /budget-transfers/{budget_transfer_id}:
    get:
      operationId: getBudgetTransfersByBudgetTransferId
      summary: Show Budget Transfer
      tags:
      - Financials Management
      parameters:
      - name: budget_transfer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget transfer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    delete:
      operationId: deleteBudgetTransfersByBudgetTransferId
      summary: Delete Budget Transfer
      tags:
      - Financials Management
      parameters:
      - name: budget_transfer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget transfer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /budget-transfers/{budget_transfer_id}/line-items/{budget_transfer_line_item_id}:
    get:
      operationId: getBudgetTransfersByBudgetTransferIdLineItemsByBudgetTransferLineItemId
      summary: Show Budget Transfer Line Item
      tags:
      - Financials Management
      parameters:
      - name: budget_transfer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget transfer.
      - name: budget_transfer_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget transfer line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /budget-transfers/{budget_transfer_id}/line-items:
    get:
      operationId: getBudgetTransfersByBudgetTransferIdLineItems
      summary: List Budget Transfer Line Items
      tags:
      - Financials Management
      parameters:
      - name: budget_transfer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget transfer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /cost-projections:
    get:
      operationId: getCostProjections
      summary: List Cost Projections
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postCostProjections
      summary: New Cost Projection
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: source_id:10100
              cost_type_id: source_id:AC
              date: '2024-06-12'
              cost_at_completion: '21000'
  /cost-projections/{cost_projection_id}:
    get:
      operationId: getCostProjectionsByCostProjectionId
      summary: Show Cost Projections
      tags:
      - Financials Management
      parameters:
      - name: cost_projection_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost projection.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putCostProjectionsByCostProjectionId
      summary: Update Cost Projection
      tags:
      - Financials Management
      parameters:
      - name: cost_projection_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost projection.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: {}
    delete:
      operationId: deleteCostProjectionsByCostProjectionId
      summary: Delete Cost Projection
      tags:
      - Financials Management
      parameters:
      - name: cost_projection_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost projection.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /budget-production-quantities:
    get:
      operationId: getBudgetProductionQuantities
      summary: List Budget Production Quantities
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postBudgetProductionQuantities
      summary: New Budget Production Quantity
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: '{{cost_code_id}}'
              quantity: '12.0'
              unit_of_measure: ea
  /budget-production-quantities/{budget_production_quantity_id}:
    get:
      operationId: getBudgetProductionQuantitiesByBudgetProductionQuantityId
      summary: Show Budget Production Quantity
      tags:
      - Financials Management
      parameters:
      - name: budget_production_quantity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget production quantity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putBudgetProductionQuantitiesByBudgetProductionQuantityId
      summary: Update Budget Production Quantity
      tags:
      - Financials Management
      parameters:
      - name: budget_production_quantity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget production quantity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: test name
              cost_type_id: source_id:B
              cost_code_id: 2e9e19e8-3d31-5e01-bdef-8f8eb3bf1353
              quantity: '12'
              unit_cost: '2'
              unit_of_measure: dollars
              original_amount: '100'
    delete:
      operationId: deleteBudgetProductionQuantitiesByBudgetProductionQuantityId
      summary: Delete Budget Production Quantity
      tags:
      - Financials Management
      parameters:
      - name: budget_production_quantity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the budget production quantity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /actual-production-quantities:
    get:
      operationId: getActualProductionQuantities
      summary: List Actual Production Quantities
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postActualProductionQuantities
      summary: New Actual Production Quantity
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: source_id:562950234240870
              date: '2024-04-23'
              quantity: '3.1'
  /actual-production-quantities/{actual_production_quantity_id}:
    get:
      operationId: getActualProductionQuantitiesByActualProductionQuantityId
      summary: Show Actual Production Quantity
      tags:
      - Financials Management
      parameters:
      - name: actual_production_quantity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the actual production quantity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putActualProductionQuantitiesByActualProductionQuantityId
      summary: Update Actual Production Quantity
      tags:
      - Financials Management
      parameters:
      - name: actual_production_quantity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the actual production quantity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              quantity: '5.2'
    delete:
      operationId: deleteActualProductionQuantitiesByActualProductionQuantityId
      summary: Delete Actual Production Quantity
      tags:
      - Financials Management
      parameters:
      - name: actual_production_quantity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the actual production quantity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /change-orders:
    get:
      operationId: getChangeOrders
      summary: List Change Orders
      tags:
      - Financials Management
      parameters:
      - name: contract_type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postChangeOrders
      summary: New Change Order
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
    patch:
      operationId: patchChangeOrders
      summary: Bulk Write Change Orders
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              creates:
              - approval_date: '2024-03-01'
                contract:
                  id: source_id:SC-L1
                  type: subcontract
                line_items:
                - contract:
                    line_item_id: source_id:1
                  amount: '50'
                  description: SCO description 1
                - contract:
                    line_item_id: source_id:1
                  amount: '51'
                  description: This is a duplicate
                - contract:
                    line_item_id: source_id:2
                  amount: '100'
                  description: SCO description 2
                - amount: '75'
                  cost_code_id: source_id:1-045
                  cost_type_id: source_id:E
                  description: New SC Line Item
                number: SCO4
                issue_date: '2024-02-01'
                name: Test Subcontract CO
                status: Approved
                type: Special
              - approval_date: '2024-03-02'
                contract:
                  id: source_id:PO-L1
                  type: purchase_order
                line_items:
                - contract:
                    line_item_id: source_id:1
                  amount: '150'
                  description: POCO description 1
                - contract:
                    line_item_id: source_id:1
                  amount: '151'
                  description: Another duplicate
                - contract:
                    line_item_id: source_id:2
                  amount: '200'
                  description: POCO description 2
                - cost_code_id: source_id:1-040
                  cost_type_id: source_id:L
                  description: New PO Line Item
                  unit_cost: '175'
                  unit_of_measure: ea
                  quantity: '10'
                number: PCO4
                issue_date: '2024-02-02'
                name: Test Purchase Order CO
                status: Approved
                type: Special
  /subcontracts/{subcontract_id}/change-orders:
    get:
      operationId: getSubcontractsBySubcontractIdChangeOrders
      summary: List Change Orders For One Subcontract
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /prime-contracts/{prime_contract_id}/change-orders:
    get:
      operationId: getPrimeContractsByPrimeContractIdChangeOrders
      summary: List Change Orders For Prime Contract
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /change-orders/{change_order_id}:
    get:
      operationId: getChangeOrdersByChangeOrderId
      summary: Show Change Order
      tags:
      - Financials Management
      parameters:
      - name: change_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putChangeOrdersByChangeOrderId
      summary: Update Change Order
      tags:
      - Financials Management
      parameters:
      - name: change_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: '{{$randomNoun}} Updated Line'
              name: '{{$randomCatchPhraseNoun}} - Updated'
    delete:
      operationId: deleteChangeOrdersByChangeOrderId
      summary: Delete Change Order
      tags:
      - Financials Management
      parameters:
      - name: change_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /change-orders/{change_order_id}/line-items:
    get:
      operationId: getChangeOrdersByChangeOrderIdLineItems
      summary: List Change Order Lines Items
      tags:
      - Financials Management
      parameters:
      - name: change_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postChangeOrdersByChangeOrderIdLineItems
      summary: New Change Order Line Item
      tags:
      - Financials Management
      parameters:
      - name: change_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              contract:
                type: subcontract
                id: '{{subcontract_id}}'
                line_item_id: '{{subcontract_line_item_id}}'
              description: '{{$randomBsNoun}} Line'
              quantity: '{{$randomInt}}'
  /change-orders/{change_order_id}/line-items/{change_order_line_item_id}:
    get:
      operationId: getChangeOrdersByChangeOrderIdLineItemsByChangeOrderLineItemId
      summary: Show Change Order Line Item
      tags:
      - Financials Management
      parameters:
      - name: change_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order.
      - name: change_order_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putChangeOrdersByChangeOrderIdLineItemsByChangeOrderLineItemId
      summary: Update Change Order Line Item
      tags:
      - Financials Management
      parameters:
      - name: change_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order.
      - name: change_order_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              quantity: '444'
              cost_type_id: '{{cost_type_id}}'
              unit_cost: '91'
              unit_of_measure: EACH
    delete:
      operationId: deleteChangeOrdersByChangeOrderIdLineItemsByChangeOrderLineItemId
      summary: Delete Change Order Line Item
      tags:
      - Financials Management
      parameters:
      - name: change_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order.
      - name: change_order_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change order line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: Custom Clad
              quantity: '44'
              cost_type_id: '{{cost_type_id}}'
              unit_cost: '91'
              unit_of_measure: EACH
  /change-events:
    get:
      operationId: getChangeEvents
      summary: List Change Events
      tags:
      - Financials Management
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postChangeEvents
      summary: New Change Event
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: Change Event
              name: CE test from postman
              scope: out_of_scope
              status: Open
              type: Allowance
              line_items:
              - amount: '105.5'
                contract:
                  id: '{{purchase_order_id}}'
                  type: purchase_order
                description: line 1 - wbs with purchase order
                quantity: '10'
                unit_cost: '10.55'
                unit_of_measure: HRS
                vendor_id: '{{vendor_id}}'
  /change-events/{change_event_id}:
    get:
      operationId: getChangeEventsByChangeEventId
      summary: Show Change Event
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putChangeEventsByChangeEventId
      summary: Update Change Event
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: Description updated in Postman
              name: Name changed in postman
              number: 020059
              scope: tbd
              status: Closed
              type: Contingency
              source_data:
                change_reason:
                  id: 598134325510442
    delete:
      operationId: deleteChangeEventsByChangeEventId
      summary: Delete Change Event
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /change-events/{change_event_id}/attachments:
    post:
      operationId: postChangeEventsByChangeEventIdAttachments
      summary: Attach to Change Event
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /change-events/{change_event_id}/line-items:
    get:
      operationId: getChangeEventsByChangeEventIdLineItems
      summary: List Change Event Lines Items
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postChangeEventsByChangeEventIdLineItems
      summary: New Change Event Line Item
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '105.5'
              contract:
                id: 9d726039-3804-55cf-84a0-b6c798505dbd
                type: purchase_order
              description: new change event line
              quantity: '10'
              unit_cost: '10.55'
              unit_of_measure: HRS
              vendor_id: 5fa88540-d37d-5dd7-9a7a-6646b81fbabb
              wbs_id: 4416d8ee-5637-567d-a862-6d0717b8d000
  /change-events/{change_event_id}/line-items/{change_event_line_item_id}:
    get:
      operationId: getChangeEventsByChangeEventIdLineItemsByChangeEventLineItemId
      summary: Show Change Event Line Item
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      - name: change_event_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    delete:
      operationId: deleteChangeEventsByChangeEventIdLineItemsByChangeEventLineItemId
      summary: Delete Change Event Line Item
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      - name: change_event_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: Custom Clad
              quantity: '44'
              cost_type_id: '{{cost_type_id}}'
              unit_cost: '91'
              unit_of_measure: EACH
    put:
      operationId: putChangeEventsByChangeEventIdLineItemsByChangeEventLineItemId
      summary: Update Change Event Line Item
      tags:
      - Financials Management
      parameters:
      - name: change_event_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event.
      - name: change_event_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the change event line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              quantity: '444'
              cost_type_id: '{{cost_type_id}}'
              unit_cost: '91'
              unit_of_measure: EACH
  /cost-codes:
    get:
      operationId: getCostCodes
      summary: List Cost Codes
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postCostCodes
      summary: New Cost Code
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /cost-codes/{cost_code_id}:
    get:
      operationId: getCostCodesByCostCodeId
      summary: Show Cost Code
      tags:
      - Financials Management
      parameters:
      - name: cost_code_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost code.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putCostCodesByCostCodeId
      summary: Update Cost Code
      tags:
      - Financials Management
      parameters:
      - name: cost_code_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost code.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: renamed
    delete:
      operationId: deleteCostCodesByCostCodeId
      summary: Delete Cost Code
      tags:
      - Financials Management
      parameters:
      - name: cost_code_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost code.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /cost-types:
    get:
      operationId: getCostTypes
      summary: List Cost Types
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postCostTypes
      summary: New Cost Type
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              code: SpaceMaterials
              name: SpaceMaterials...
  /cost-types/{cost_type_id}:
    put:
      operationId: putCostTypesByCostTypeId
      summary: Update Cost Type
      tags:
      - Financials Management
      parameters:
      - name: cost_type_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost type.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              code: SUB
              name: Subcontracts
    get:
      operationId: getCostTypesByCostTypeId
      summary: Show Cost Type
      tags:
      - Financials Management
      parameters:
      - name: cost_type_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost type.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    delete:
      operationId: deleteCostTypesByCostTypeId
      summary: Delete Cost Type
      tags:
      - Financials Management
      parameters:
      - name: cost_type_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the cost type.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /sub-jobs:
    get:
      operationId: getSubJobs
      summary: List Sub-Jobs
      tags:
      - Financials Management
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /sub-jobs/{sub_job_id}:
    get:
      operationId: getSubJobsBySubJobId
      summary: Show Sub-Job
      tags:
      - Financials Management
      parameters:
      - name: sub_job_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the sub job.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /vendors/compliances:
    get:
      operationId: getVendorsCompliances
      summary: List Vendor Compliances (All Vendors)
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /vendors/{vendor_id}/compliances:
    get:
      operationId: getVendorsByVendorIdCompliances
      summary: List Vendor Compliances (One Vendor)
      tags:
      - Financials Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postVendorsByVendorIdCompliances
      summary: New Vendor Compliance
      tags:
      - Financials Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: This confirms we received the MSDS for the vendor
              status: Compliant
              type: Material Safety Data Sheets
  /vendors/{vendor_id}/compliances/{vendor_compliance_id}:
    get:
      operationId: getVendorsByVendorIdCompliancesByVendorComplianceId
      summary: Show Vendor Compliance
      tags:
      - Financials Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      - name: vendor_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putVendorsByVendorIdCompliancesByVendorComplianceId
      summary: Update Vendor Compliance
      tags:
      - Financials Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      - name: vendor_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: updated description
              status: Non-Compliant
    delete:
      operationId: deleteVendorsByVendorIdCompliancesByVendorComplianceId
      summary: Delete Vendor Compliance
      tags:
      - Financials Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      - name: vendor_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /subcontracts/compliances:
    get:
      operationId: getSubcontractsCompliances
      summary: List Subcontract Compliances (All Subcontracts)
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /subcontracts/{subcontract_id}/compliances:
    get:
      operationId: getSubcontractsBySubcontractIdCompliances
      summary: List Subcontract Compliances (One Subcontract)
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postSubcontractsBySubcontractIdCompliances
      summary: New Subcontract Compliance
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '1000002'
              effective_date: '2022-01-01'
              expiration_date: '2023-01-01'
              policy_number: 123 45 6789
              provider_name: PRO
              status: Compliant
              type: INS
              vendor_id: source_id:FEDEX
  /subcontracts/{subcontract_id}/compliances/{subcontract_compliance_id}:
    get:
      operationId: getSubcontractsBySubcontractIdCompliancesBySubcontractComplianceId
      summary: Show Subcontract Compliance
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      - name: subcontract_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putSubcontractsBySubcontractIdCompliancesBySubcontractComplianceId
      summary: Update Subcontract Compliance
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      - name: subcontract_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: updated description
              status: Non-Compliant
              receive_date: '2023-01-01'
    delete:
      operationId: deleteSubcontractsBySubcontractIdCompliancesBySubcontractComplianceId
      summary: Delete Subcontract Compliance
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      - name: subcontract_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /purchase-orders/compliances:
    get:
      operationId: getPurchaseOrdersCompliances
      summary: List Purchase Order Compliances (All Purchase Ordes)
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /purchase-orders/{purchase_order_id}/compliances:
    get:
      operationId: getPurchaseOrdersByPurchaseOrderIdCompliances
      summary: List Purchase Order Compliances (One Purchase Order)
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postPurchaseOrdersByPurchaseOrderIdCompliances
      summary: New Purchase Order Compliance
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: Expires in the future
              expiration_date: '2024-06-18'
              type: Certified Payroll
  /purchase-orders/{purchase_order_id}/compliances/{purchase_order_compliance_id}:
    get:
      operationId: getPurchaseOrdersByPurchaseOrderIdCompliancesByPurchaseOrderComplianceId
      summary: Show Purchase Order Compliance
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      - name: purchase_order_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putPurchaseOrdersByPurchaseOrderIdCompliancesByPurchaseOrderComplianceId
      summary: Update Purchase Order Compliance
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      - name: purchase_order_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              expiration_date: '2022-11-11'
              description: expired
    delete:
      operationId: deletePurchaseOrdersByPurchaseOrderIdCompliancesByPurchaseOrderComplianceId
      summary: Delete Purchase Order Compliance
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      - name: purchase_order_compliance_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order compliance.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /employees:
    get:
      operationId: getEmployees
      summary: List Employees
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postEmployees
      summary: New Employee
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                city: San Clemente
                postal_code: '92672'
                state: CA
                street_1: 240 Avenida Vista Montana
                street_2: C/O Foreman
              code: '253'
              email: ds@aol.com
              first_name: Dan
              gender: Male
              hire_date: '1989-08-14'
              industry: Laborer
              last_name: Simmons
              phone: '2169875623'
              termination_date: '2024-01-02'
              source_data:
                fed_filing_status: S
                tax_state: CA
                state_filing_status: S
                pay_periods_per_year: '26'
                middle_initial: L
                minority_no: BLK
                pay_rate: '14.00000'
                earn_type_no: REG
                cost_code_no: LAB
                wc_state: CA
                pension: N
                veteran: N
                pay_period_no: W
  /employees/{employee_id}:
    get:
      operationId: getEmployeesByEmployeeId
      summary: Show Employee
      tags:
      - Financials Management
      parameters:
      - name: employee_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the employee.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putEmployeesByEmployeeId
      summary: Update Employee
      tags:
      - Financials Management
      parameters:
      - name: employee_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the employee.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
    delete:
      operationId: deleteEmployeesByEmployeeId
      summary: Delete Employee
      tags:
      - Financials Management
      parameters:
      - name: employee_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the employee.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /estimates:
    get:
      operationId: getEstimates
      summary: List Estimates
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postEstimates
      summary: New Estimate
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                city: AnyTown
                country: USA
                postal_code: '19703'
                state: CA
                street_1: 123 Main Street
                street_2: Unit 12
              customer_id: '{{customer_id}}'
              due_date: '2023-02-07'
              line_items:
              - amount: '8.00'
                description: Painting
                item_id: '{{item_id}}'
                quantity: '2'
                unit_price: '4.00'
              - amount: '15.00'
                description: Cleanup & Restoration
                item_id: '{{item_id}}'
                quantity: '5'
                unit_price: '3.00'
              name: test memo
              status: Active
              transaction_date: '2023-02-07'
              type: null
  /estimates/{estimate_id}:
    get:
      operationId: getEstimatesByEstimateId
      summary: Show Estimate
      tags:
      - Financials Management
      parameters:
      - name: estimate_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putEstimatesByEstimateId
      summary: Update Estimate
      tags:
      - Financials Management
      parameters:
      - name: estimate_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                city: AnyTown2
                country: USA
                postal_code: '19704'
                state: NV
                street_1: 123 Main Street 2
                street_2: Unit 122
              customer_id: '{{customer_id}}'
              due_date: '2023-02-09'
              name: test memo 2
              status: Active
              transaction_date: '2023-02-02'
              type: Labor Costs
    delete:
      operationId: deleteEstimatesByEstimateId
      summary: Delete Estimate
      tags:
      - Financials Management
      parameters:
      - name: estimate_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              delivery_address:
                city: TEST City
                country: TEST Country
                postal_code: TEST Code
                state: TEST State
                street_1: TEST St1
                street_2: TEST St2
              name: test name
              number: test number
              order_date: '2022-04-04'
              ship_via: test ship_via
              status: Open
              terms: test terms
              vendor_id: 094b57f7-7362-5448-b113-152076379737
              type: test type
              ledger_account_id: 341fdd21-aee8-5517-bfc7-fa0731d76a0d
              line_items:
              - amount: '102'
                description: My line item
                ledger_account_id: d4c2281f-6210-5894-99bb-9aa98180216c
                type: AccountBasedExpenseLineDetail
                status: Billable
                customer_id: 693f8cb6-f10e-5c6b-a4c8-6e2dbe738d8c
              - amount: '102'
                description: My line item
                ledger_account_id: d4c2281f-6210-5894-99bb-9aa98180216c
                type: AccountBasedExpenseLineDetail
              - amount: '102'
                description: My line item
                ledger_account_id: d4c2281f-6210-5894-99bb-9aa98180216c
                type: AccountBasedExpenseLineDetail
  /estimates/{estimate_id}/line-items:
    get:
      operationId: getEstimatesByEstimateIdLineItems
      summary: List Estimate Line Items
      tags:
      - Financials Management
      parameters:
      - name: estimate_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postEstimatesByEstimateIdLineItems
      summary: New Estimate Line Item
      tags:
      - Financials Management
      parameters:
      - name: estimate_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '4.00'
              description: Painting 2
              item_id: '{{item_id}}'
              quantity: '23'
              unit_price: '1.00'
  /estimates/{estimate_id}/line-items/{estimate_line_item_id}:
    get:
      operationId: getEstimatesByEstimateIdLineItemsByEstimateLineItemId
      summary: Show Estimate Line Item
      tags:
      - Financials Management
      parameters:
      - name: estimate_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate.
      - name: estimate_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              actual_completion_date: '2022-08-25'
              contractor_id: '{{vendor_id}}'
              defects_expiry_date: '2022-08-27'
              defects_period: ''
              description: Contract by Pooria via Agave 5
              estimated_completion_date: '2022-08-27'
              execution_date: '2022-05-27'
              full_release_date: '2022-02-27'
              half_release_date: '2022-08-27'
              is_executed: true
              retainage_percent: 25
              retention_based_on: Unknown
              sent_date: '2022-01-01'
              start_date: '2022-01-02'
              total_amount: ''
              type: Lump Sum
    put:
      operationId: putEstimatesByEstimateIdLineItemsByEstimateLineItemId
      summary: Update Estimate Line Item
      tags:
      - Financials Management
      parameters:
      - name: estimate_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate.
      - name: estimate_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '43.00'
              description: Painting 23
              item_id: '{{item_id}}'
              quantity: '233'
              unit_price: '13.00'
    delete:
      operationId: deleteEstimatesByEstimateIdLineItemsByEstimateLineItemId
      summary: Delete Estimate Line Item
      tags:
      - Financials Management
      parameters:
      - name: estimate_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate.
      - name: estimate_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the estimate line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /expenses:
    get:
      operationId: getExpenses
      summary: List Expenses
      tags:
      - Financials Management
      parameters:
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postExpenses
      summary: New Expense
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              bank_account_id: source_id:35
              description: Test description
              number: '577'
              payment_date: '2023-01-01'
              payment_method: Check
              status: Paid
              vendor_id: source_id:35
              line_items:
              - amount: '10'
                customer_id: source_id:96892
                description: Test Account Line Item
                ledger_account_id: source_id:13
                status: NotBillable
                type: Revenue - Job
              - amount: '6'
                customer_id: source_id:96892
                description: Test Item Line Item
                item_id: source_id:3
                status: Billable
                unit_cost: '6'
                quantity: '1'
                type: Revenue - Job
  /expenses/{expense_id}:
    get:
      operationId: getExpensesByExpenseId
      summary: Show Expense
      tags:
      - Financials Management
      parameters:
      - name: expense_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putExpensesByExpenseId
      summary: Update Expense
      tags:
      - Financials Management
      parameters:
      - name: expense_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: New expense from Postman, updated
              number: '3105'
              payment_date: '2022-12-24'
              vendor_id: '{{vendor_id}}'
    delete:
      operationId: deleteExpensesByExpenseId
      summary: Delete Expense
      tags:
      - Financials Management
      parameters:
      - name: expense_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              delivery_address:
                city: TEST City
                country: TEST Country
                postal_code: TEST Code
                state: TEST State
                street_1: TEST St1
                street_2: TEST St2
              name: test name
              number: test number
              order_date: '2022-04-04'
              ship_via: test ship_via
              status: Open
              terms: test terms
              vendor_id: 094b57f7-7362-5448-b113-152076379737
              type: test type
              ledger_account_id: 341fdd21-aee8-5517-bfc7-fa0731d76a0d
              line_items:
              - amount: '102'
                description: My line item
                ledger_account_id: d4c2281f-6210-5894-99bb-9aa98180216c
                type: AccountBasedExpenseLineDetail
                status: Billable
                customer_id: 693f8cb6-f10e-5c6b-a4c8-6e2dbe738d8c
              - amount: '102'
                description: My line item
                ledger_account_id: d4c2281f-6210-5894-99bb-9aa98180216c
                type: AccountBasedExpenseLineDetail
              - amount: '102'
                description: My line item
                ledger_account_id: d4c2281f-6210-5894-99bb-9aa98180216c
                type: AccountBasedExpenseLineDetail
  /expenses/{expense_id}/line-items:
    get:
      operationId: getExpensesByExpenseIdLineItems
      summary: List Expense Line Items
      tags:
      - Financials Management
      parameters:
      - name: expense_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postExpensesByExpenseIdLineItems
      summary: New Expense Line Item
      tags:
      - Financials Management
      parameters:
      - name: expense_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '100.00'
              description: Two tons of cement.
              quantity: '2.0'
              type: Subcontract
              unit_cost: '50.00000'
              contract:
                id: source_id:SC-100
                line_item_id: source_id:2
                type: subcontract
  /expenses/{expense_id}/line-items/{expense_line_item_id}:
    get:
      operationId: getExpensesByExpenseIdLineItemsByExpenseLineItemId
      summary: Show Expense Line Item
      tags:
      - Financials Management
      parameters:
      - name: expense_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense.
      - name: expense_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              actual_completion_date: '2022-08-25'
              contractor_id: '{{vendor_id}}'
              defects_expiry_date: '2022-08-27'
              defects_period: ''
              description: Contract by Pooria via Agave 5
              estimated_completion_date: '2022-08-27'
              execution_date: '2022-05-27'
              full_release_date: '2022-02-27'
              half_release_date: '2022-08-27'
              is_executed: true
              retainage_percent: 25
              retention_based_on: Unknown
              sent_date: '2022-01-01'
              start_date: '2022-01-02'
              total_amount: ''
              type: Lump Sum
    put:
      operationId: putExpensesByExpenseIdLineItemsByExpenseLineItemId
      summary: Update Expense Line Item
      tags:
      - Financials Management
      parameters:
      - name: expense_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense.
      - name: expense_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '43.00'
              description: test
    delete:
      operationId: deleteExpensesByExpenseIdLineItemsByExpenseLineItemId
      summary: Delete Expense Line Item
      tags:
      - Financials Management
      parameters:
      - name: expense_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense.
      - name: expense_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the expense line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /items:
    get:
      operationId: getItems
      summary: List Items
      tags:
      - Financials Management
      parameters:
      - name: type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postItems
      summary: New Item
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              expense_account_id: '{{expense_account_id}}'
              income_account_id: '{{income_account_id}}'
              asset_account_id: '{{asset_account_id}}'
              name: Test Child Item
              status: Active
              type: Service
              unit_cost: '1.33'
              unit_price: '2.33'
  /items/{item_id}:
    get:
      operationId: getItemsByItemId
      summary: Show Item
      tags:
      - Financials Management
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putItemsByItemId
      summary: Update Item
      tags:
      - Financials Management
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              account_id: b6cc53c8-ae13-5b9c-96e9-2287229b6a54
              description: Concrete for fountain installation
              name: Concrete 6
              status: Active
              unit_price: '12'
    delete:
      operationId: deleteItemsByItemId
      summary: Delete Item
      tags:
      - Financials Management
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /item-receipts:
    get:
      operationId: getItemReceipts
      summary: List Item Receipts
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postItemReceipts
      summary: New Item Receipt
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /item-receipts/{item_receipt_id}:
    get:
      operationId: getItemReceiptsByItemReceiptId
      summary: Show Item Receipt
      tags:
      - Financials Management
      parameters:
      - name: item_receipt_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putItemReceiptsByItemReceiptId
      summary: Update Item Receipt
      tags:
      - Financials Management
      parameters:
      - name: item_receipt_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: test123
              delivery_date: '2024-09-01'
    delete:
      operationId: deleteItemReceiptsByItemReceiptId
      summary: Delete Item Receipt
      tags:
      - Financials Management
      parameters:
      - name: item_receipt_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /item-receipts/{item_receipt_id}/line-items:
    get:
      operationId: getItemReceiptsByItemReceiptIdLineItems
      summary: List Item Receipt Line Items
      tags:
      - Financials Management
      parameters:
      - name: item_receipt_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postItemReceiptsByItemReceiptIdLineItems
      summary: New Item Receipt Line Item
      tags:
      - Financials Management
      parameters:
      - name: item_receipt_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              contract:
                id: 2f1e91bc-1c62-55b9-ad9f-2aa3bf3d8391
                line_item_id: cff41e0d-46e1-5d19-8dc5-a59eb4cef8aa
              item_id: f64f0ceb-cd77-5400-b4b1-a3e6da0c98ae
              quantity: '1'
  /item-receipts/{item_receipt_id}/line-items/{item_receipt_line_item_id}:
    get:
      operationId: getItemReceiptsByItemReceiptIdLineItemsByItemReceiptLineItemId
      summary: Show Item Receipt Line Items
      tags:
      - Financials Management
      parameters:
      - name: item_receipt_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt.
      - name: item_receipt_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putItemReceiptsByItemReceiptIdLineItemsByItemReceiptLineItemId
      summary: Update Item Receipt Line Item
      tags:
      - Financials Management
      parameters:
      - name: item_receipt_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt.
      - name: item_receipt_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              contract:
                id: 2f1e91bc-1c62-55b9-ad9f-2aa3bf3d8391
                line_item_id: cff41e0d-46e1-5d19-8dc5-a59eb4cef8aa
              item_id: f64f0ceb-cd77-5400-b4b1-a3e6da0c98ae
              quantity: '0.2'
    delete:
      operationId: deleteItemReceiptsByItemReceiptIdLineItemsByItemReceiptLineItemId
      summary: Delete Item Receipt Line Item
      tags:
      - Financials Management
      parameters:
      - name: item_receipt_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt.
      - name: item_receipt_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the item receipt line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /job-costs:
    get:
      operationId: getJobCosts
      summary: List Job Costs
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postJobCosts
      summary: New Job Cost
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: '{{$randomProductName}}'
              number: '{{$randomInt}}{{$randomAlphaNumeric}}'
              actual_amount: '20'
              actual_quantity: '2'
              actual_unit_cost: '10'
              actual_unit_of_measure: ea
              cost_code_id: 8715d4a1-e638-5f83-be64-c509383ddf89
              cost_type_id: 75d963ad-dcc7-50f3-a4ab-def6370ad909
              description: '{{$randomJobDescriptor}}'
              source_data:
                supplierName: The Malcolm Company, Inc.
  /job-costs/{job_cost_id}:
    get:
      operationId: getJobCostsByJobCostId
      summary: Show Job Cost
      tags:
      - Financials Management
      parameters:
      - name: job_cost_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the job cost.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putJobCostsByJobCostId
      summary: Update Job Cost
      tags:
      - Financials Management
      parameters:
      - name: job_cost_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the job cost.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
    delete:
      operationId: deleteJobCostsByJobCostId
      summary: Delete Job Cost
      tags:
      - Financials Management
      parameters:
      - name: job_cost_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the job cost.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ledger-accounts:
    get:
      operationId: getLedgerAccounts
      summary: List Ledger Accounts
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postLedgerAccounts
      summary: New Ledger Account
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: Test New Ledger Account
              status: Active
              source_data:
                BaseCurrency: USD
                TimeZone: (UTC-08:00) Pacific Time (US & Canada)
                DisplayId: '105091'
                Language: En
  /ledger-accounts/{ledger_account_id}:
    get:
      operationId: getLedgerAccountsByLedgerAccountId
      summary: Show Ledger Account
      tags:
      - Financials Management
      parameters:
      - name: ledger_account_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger account.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putLedgerAccountsByLedgerAccountId
      summary: Update Ledger Account
      tags:
      - Financials Management
      parameters:
      - name: ledger_account_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger account.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /ledger-journals:
    get:
      operationId: getLedgerJournals
      summary: List Ledger Journals
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ledger-journals/{ledger_journal_id}:
    get:
      operationId: getLedgerJournalsByLedgerJournalId
      summary: Show Ledger Journal
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postLedgerJournalsByLedgerJournalId
      summary: New Ledger Journal
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              code: ''
              name: ''
              type: ''
    put:
      operationId: putLedgerJournalsByLedgerJournalId
      summary: Update Ledger Journal
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /ledger-journal-entries:
    get:
      operationId: getLedgerJournalEntries
      summary: List Ledger Journal Entries
      tags:
      - Financials Management
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      - name: expand
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postLedgerJournalEntries
      summary: New Ledger Journal Entry
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              post_date: '2023-12-01'
              line_items:
              - credit_amount: '0.00'
                debit_amount: '75.00'
                reference: ref-001
                ledger_account_id: b59f821f-d8ad-591c-b319-92b945df8b14
                ledger_journal_id: 293b2785-84bb-51ee-9af4-ccfad1f5d6ca
              - credit_amount: '50.00'
                debit_amount: '0.00'
                reference: ref-001
                ledger_account_id: 554b526f-89a1-563c-ad04-08ec53059f3d
                ledger_journal_id: 293b2785-84bb-51ee-9af4-ccfad1f5d6ca
              - credit_amount: '25.00'
                debit_amount: '0.00'
                reference: ref-001
                ledger_account_id: 77187b17-2fbc-5f4a-ab18-85bcf45ef0ea
                ledger_journal_id: 293b2785-84bb-51ee-9af4-ccfad1f5d6ca
  /ledger-journal-entries/{ledger_journal_entry_id}:
    get:
      operationId: getLedgerJournalEntriesByLedgerJournalEntryId
      summary: Show Ledger Journal Entry
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putLedgerJournalEntriesByLedgerJournalEntryId
      summary: Update Ledger Journal Entry
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              status: Posted
    delete:
      operationId: deleteLedgerJournalEntriesByLedgerJournalEntryId
      summary: Delete Ledger Journal Entry
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /ledger-journal-entries/{ledger_journal_entry_id}/line-items:
    get:
      operationId: getLedgerJournalEntriesByLedgerJournalEntryIdLineItems
      summary: List Ledger Journal Entry Line Items
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postLedgerJournalEntriesByLedgerJournalEntryIdLineItems
      summary: New Ledger Journal Entry Line Item
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              credit_amount: '0.00'
              debit_amount: '95.00'
              reference: ref-002
              ledger_account_id: 50a3b77e-a8f2-5a95-920b-5ac0cc324934
              ledger_journal_id: e826b32d-6b53-597c-b4ee-b7a2f657f15d
  /ledger-journal-entries/{ledger_journal_entry_id}/line-items/{ledger_journal_entry_line_item_id}:
    get:
      operationId: getLedgerJournalEntriesByLedgerJournalEntryIdLineItemsByLedgerJournalEntryLineItemId
      summary: Show Ledger Journal Entry Line Item
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry.
      - name: ledger_journal_entry_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putLedgerJournalEntriesByLedgerJournalEntryIdLineItemsByLedgerJournalEntryLineItemId
      summary: Update Ledger Journal Entry Line Item
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry.
      - name: ledger_journal_entry_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              credit_amount: '0.00'
              debit_amount: '11.00'
              reference: ref-001
              ledger_account_id: b59f821f-d8ad-591c-b319-92b945df8b14
              ledger_journal_id: 293b2785-84bb-51ee-9af4-ccfad1f5d6ca
    delete:
      operationId: deleteLedgerJournalEntriesByLedgerJournalEntryIdLineItemsByLedgerJournalEntryLineItemId
      summary: Delete Ledger Journal Entry Line Item
      tags:
      - Financials Management
      parameters:
      - name: ledger_journal_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry.
      - name: ledger_journal_entry_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the ledger journal entry line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /purchase-orders:
    get:
      operationId: getPurchaseOrders
      summary: List Purchase Orders
      tags:
      - Financials Management
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postPurchaseOrders
      summary: New Purchase Order
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              delivery_address:
                street_1: 123 Main Street
                street_2: Unit B
                city: AnyTown
                state: CA
                country: US
                postal_code: '19703'
              delivery_date: '2022-01-02'
              name: Initial Cement Order
              number: '12019'
              order_date: '2022-01-01'
              status: PM
              terms: Net 90 days
              type: Purchase Order
              vendor_id: source_id:21
              line_items:
              - cost_code_id: source_id:030000-00-0000
                cost_type_id: source_id:2
                description: 1/4 PEA GRAVEL
                item_id: source_id:3
                quantity: '10.0'
                status: Non-Interfaced
                tax_code_id: source_id:CA
                unit_cost: '7.75000'
                unit_of_measure: TON
              - cost_code_id: source_id:030000-00-0000
                cost_type_id: source_id:2
                description: 1/4 PEA GRAVEL
                item_id: source_id:3
                quantity: '10.0'
                status: Non-Interfaced
                tax_code_id: source_id:CA
                unit_cost: '7.75000'
                unit_of_measure: TON
    patch:
      operationId: patchPurchaseOrders
      summary: Bulk Write Purchase Orders
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              creates:
              - approval_date: '2024-01-01'
                delivery_address:
                  street_1: 1 Main Street
                  street_2: Unit A
                  city: A Town
                  state: CA
                  postal_code: '11111'
                delivery_date: '2024-01-02'
                description: Great Description 1
                issue_date: '2024-01-03'
                name: First Cement Order
                number: '17116'
                order_date: '2024-01-04'
                ship_via: Shipper 1
                status: Printed
                terms: Net 30 days
                vendor_id: '{{vendor_id}}'
                line_items:
                - cost_code_id: source_id:1-040
                  cost_type_id: source_id:E
                  description: PO1 Item 1
                  quantity: '10.0'
                  tax_code_id: source_id:MET
                  unit_cost: '7.7500'
                  unit_of_measure: ea
                - cost_code_id: source_id:bad
                  cost_type_id: source_id:2
                  description: Won't get written
                  amount: '11'
                - cost_code_id: source_id:1-045
                  cost_type_id: source_id:L
                  description: PO1 Item 2
                  amount: '100'
                  tax_code_id: source_id:OR
              - number: '17111'
                description: A duplicate
                vendor_id: '{{vendor_id}}'
                line_items:
                - cost_code_id: source_id:NA
                  amount: '100'
                  description: Doesn't matter
              - approval_date: '2024-02-01'
                delivery_address:
                  street_1: 2 Main Street
                  street_2: Unit B
                  city: B Town
                  state: CA
                  postal_code: '22222'
                delivery_date: '2024-02-02'
                description: Great Description 2
                issue_date: '2024-02-03'
                name: Second Cement Order
                number: '17226'
                order_date: '2024-02-04'
                ship_via: Shipper 2
                status: Printed
                terms: Net 60 days
                vendor_id: '{{vendor_id}}'
                line_items:
                - cost_code_id: source_id:2-010
                  cost_type_id: source_id:E
                  description: PO2 Item 1
                  quantity: '20.0'
                  unit_cost: '5.7500'
                  unit_of_measure: lb
                - cost_code_id: source_id:bad
                  cost_type_id: source_id:2
                  description: Won't get written
                  amount: '22'
                - cost_code_id: source_id:2-050
                  cost_type_id: source_id:L
                  description: PO2 Item 2
                  amount: '200'
  /purchase-orders/{purchase_order_id}:
    get:
      operationId: getPurchaseOrdersByPurchaseOrderId
      summary: Show Purchase Order
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putPurchaseOrdersByPurchaseOrderId
      summary: Update Purchase Order
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              delivery_address:
                street_1: 123 Main Street
                street_2: Unit B
                city: AnyTown
                state: CA
                country: US
                postal_code: '19703'
              delivery_date: '2022-01-02'
              name: Initial Cement Order
              number: '12010'
              order_date: '2022-01-01'
              project_id: source_id:A123- C
              status: PM
              terms: Net 90 days
              type: PO
              vendor_id: source_id:10
    delete:
      operationId: deletePurchaseOrdersByPurchaseOrderId
      summary: Delete Purchase Order
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /purchase-orders/{purchase_order_id}/line-items:
    get:
      operationId: getPurchaseOrdersByPurchaseOrderIdLineItems
      summary: List Purchase Order Line Items
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postPurchaseOrdersByPurchaseOrderIdLineItems
      summary: New Purchase Order Line Item
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: source_id:030000-00-0000
              cost_type_id: source_id:2
              description: 1/4 PEA GRAVEL
              item_id: source_id:3
              quantity: '10.0'
              status: Non-Interfaced
              tax_code_id: source_id:CA
              unit_cost: '7.75000'
              unit_of_measure: TON
  /purchase-orders/{purchase_order_id}/line-items/{purchase_order_line_item_id}:
    get:
      operationId: getPurchaseOrdersByPurchaseOrderIdLineItemsByPurchaseOrderLineItemId
      summary: Show Purchase Order Line Item
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      - name: purchase_order_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              actual_completion_date: '2022-08-25'
              contractor_id: '{{vendor_id}}'
              defects_expiry_date: '2022-08-27'
              defects_period: ''
              description: Contract by Pooria via Agave 5
              estimated_completion_date: '2022-08-27'
              execution_date: '2022-05-27'
              full_release_date: '2022-02-27'
              half_release_date: '2022-08-27'
              is_executed: true
              retainage_percent: 25
              retention_based_on: Unknown
              sent_date: '2022-01-01'
              start_date: '2022-01-02'
              total_amount: ''
              type: Lump Sum
    put:
      operationId: putPurchaseOrdersByPurchaseOrderIdLineItemsByPurchaseOrderLineItemId
      summary: Update Purchase Order Line Item
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      - name: purchase_order_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: 337db147-8267-56de-8d84-8785fb789069
              unit_of_measure: $
    delete:
      operationId: deletePurchaseOrdersByPurchaseOrderIdLineItemsByPurchaseOrderLineItemId
      summary: Delete Purchase Order Line Item
      tags:
      - Financials Management
      parameters:
      - name: purchase_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order.
      - name: purchase_order_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the purchase order line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /prime-contracts:
    get:
      operationId: getPrimeContracts
      summary: List Prime Contracts
      tags:
      - Financials Management
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postPrimeContracts
      summary: New Prime Contract
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: '{{$randomFullName}}'
              number: '{{$randomAlphaNumeric}}-{{$randomInt}}'
              actual_completion_date: '2023-12-23'
              contact_id: '{{contact_id}}'
              description: '{{$randomStreetName}}'
              estimated_completion_date: '2023-12-23'
              execution_date: '2023-12-23'
              start_date: '2023-12-23'
              status: Executed
              type: Cost Plus
              vendor_id: '{{vendor_id}}'
              retention_percent: '5'
              line_items:
              - amount: '{{$randomInt}}'
                description: '{{$randomLastName}}'
                quantity: '{{$randomInt}}'
                unit_cost: '{{$randomPrice}}'
                unit_of_measure: '{{$randomCurrencyCode}}'
                number: '{{$randomAlphaNumeric}}-{{$randomInt}}'
  /prime-contracts/{prime_contract_id}:
    get:
      operationId: getPrimeContractsByPrimeContractId
      summary: Show Prime Contract
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putPrimeContractsByPrimeContractId
      summary: Update Prime Contract
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: '{{$randomFullName}}'
              number: '{{$randomAlphaNumeric}}-{{$randomInt}}'
              actual_completion_date: '2023-12-23'
              contact_id: '{{contact_id}}'
              description: '{{$randomStreetName}}'
              estimated_completion_date: '2023-12-23'
              execution_date: '2023-12-23'
              start_date: '2023-12-23'
              status: Executed
              type: Fixed Price
              vendor_id: '{{vendor_id}}'
    delete:
      operationId: deletePrimeContractsByPrimeContractId
      summary: Delete Prime Contract
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /prime-contracts/{prime_contract_id}/line-items:
    get:
      operationId: getPrimeContractsByPrimeContractIdLineItems
      summary: List Prime Contract Line Items
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postPrimeContractsByPrimeContractIdLineItems
      summary: New Prime Contract Line Item
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '{{$randomInt}}'
              description: '{{$randomLastName}}'
              quantity: '{{$randomInt}}'
              unit_cost: '{{$randomPrice}}'
              unit_of_measure: '{{$randomCurrencyCode}}'
              number: '{{$randomAlphaNumeric}}-{{$randomInt}}'
  /prime-contracts/{prime_contract_id}/line-items/{prime_contract_line_item_id}:
    get:
      operationId: getPrimeContractsByPrimeContractIdLineItemsByPrimeContractLineItemId
      summary: Show Prime Contract Line Item
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      - name: prime_contract_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putPrimeContractsByPrimeContractIdLineItemsByPrimeContractLineItemId
      summary: Update Prime Contract Line Item
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      - name: prime_contract_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: '{{$randomInt}}'
              description: '{{$randomLastName}}'
              quantity: '{{$randomInt}}'
              unit_cost: '{{$randomPrice}}'
              unit_of_measure: '{{$randomCurrencyCode}}'
              number: '{{$randomAlphaNumeric}}-{{$randomInt}}'
    delete:
      operationId: deletePrimeContractsByPrimeContractIdLineItemsByPrimeContractLineItemId
      summary: Delete Prime Contract Line Item
      tags:
      - Financials Management
      parameters:
      - name: prime_contract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract.
      - name: prime_contract_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the prime contract line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /subcontracts:
    get:
      operationId: getSubcontracts
      summary: List Subcontracts
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postSubcontracts
      summary: New Subcontract
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /subcontracts/{subcontract_id}:
    get:
      operationId: getSubcontractsBySubcontractId
      summary: Show Subcontract
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putSubcontractsBySubcontractId
      summary: Update Subcontract
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: Test Changre Order to Post 2 XYZ1234
              number: 16-001.027
              status: PENDING
              vendor_id: 59339f48-6d8e-5cf8-ad34-a9d1ac06fe3d
              source_data: {}
    delete:
      operationId: deleteSubcontractsBySubcontractId
      summary: Delete Subcontract
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /subcontracts/{subcontract_id}/line-items:
    get:
      operationId: getSubcontractsBySubcontractIdLineItems
      summary: List Subcontract Line Items
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      - name: sub
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postSubcontractsBySubcontractIdLineItems
      summary: New Subcontract Line Item
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: 8c9ba3ae-5932-5c5e-8b43-129661be6369
              cost_type_id: 1fced983-dba5-538a-8a24-9bcf8749cd08
              unit_of_measure: each
              amount: '10.2'
              quantity: '21'
  /subcontracts/{subcontract_id}/line-items/{subcontract_line_item_id}:
    get:
      operationId: getSubcontractsBySubcontractIdLineItemsBySubcontractLineItemId
      summary: Show Subcontract Line Item
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      - name: subcontract_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putSubcontractsBySubcontractIdLineItemsBySubcontractLineItemId
      summary: Update Subcontract Line Item
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      - name: subcontract_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: 5b0066ea-b9e8-5d47-8c7a-dc48b0b7c1b9
              amount: '9.12'
              quantity: '11'
              unit_of_measure: hrs
    delete:
      operationId: deleteSubcontractsBySubcontractIdLineItemsBySubcontractLineItemId
      summary: Delete Subcontract Line Item
      tags:
      - Financials Management
      parameters:
      - name: subcontract_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract.
      - name: subcontract_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /subcontract-claims:
    get:
      operationId: getSubcontractClaims
      summary: List Subcontract Claims
      tags:
      - Financials Management
      parameters:
      - name: expand
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postSubcontractClaims
      summary: New Subcontract Claim
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              ap_invoice_date: '2023-06-14'
              ap_invoice_number: SubClaim3
              approval_date: '2023-06-16'
              approval_retention_amount: '13.50'
              claim_date: '2023-12-10'
              claim_number: '5'
              contract:
                id: 966042ef-ca36-5bfa-8ca9-7a7a84686252
                type: subcontract
              description: Test Subcontract Claim 5
              due_date: '2023-07-16'
              status: Certified
  /subcontract-claims/{subcontract_claim_id}:
    get:
      operationId: getSubcontractClaimsBySubcontractClaimId
      summary: Show Subcontract Claim
      tags:
      - Financials Management
      parameters:
      - name: subcontract_claim_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putSubcontractClaimsBySubcontractClaimId
      summary: Update Subcontract Claim
      tags:
      - Financials Management
      parameters:
      - name: subcontract_claim_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: Updated
              status: Pending
    delete:
      operationId: deleteSubcontractClaimsBySubcontractClaimId
      summary: Delete Subcontract Claim
      tags:
      - Financials Management
      parameters:
      - name: subcontract_claim_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /subcontract-claims/{subcontract_claim_id}/line-items:
    get:
      operationId: getSubcontractClaimsBySubcontractClaimIdLineItems
      summary: List Subcontract Claim Line Items
      tags:
      - Financials Management
      parameters:
      - name: subcontract_claim_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postSubcontractClaimsBySubcontractClaimIdLineItems
      summary: New Subcontract Claim Line Item
      tags:
      - Financials Management
      parameters:
      - name: subcontract_claim_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              cost_code_id: 337db147-8267-56de-8d84-8785fb789069
              unit_of_measure: $
              source_data:
                ScschVenCode: '3456'
                ScschChgCode: '000'
                ScschCatCode: M
                ScschTaskCode: '1'
  /subcontract-claims/{subcontract_claim_id}/line-items/{subcontract_claim_line_item_id}:
    get:
      operationId: getSubcontractClaimsBySubcontractClaimIdLineItemsBySubcontractClaimLineItemId
      summary: Show Subcontract Claim Line Item
      tags:
      - Financials Management
      parameters:
      - name: subcontract_claim_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim.
      - name: subcontract_claim_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putSubcontractClaimsBySubcontractClaimIdLineItemsBySubcontractClaimLineItemId
      summary: Update Subcontract Claim Line Item
      tags:
      - Financials Management
      parameters:
      - name: subcontract_claim_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim.
      - name: subcontract_claim_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              approval_amount: '100.00'
              approval_quantity: '10.000'
              approval_retention_amount: '1.00'
              claim_amount: '200.00'
              claim_quantity: '20.000'
              description: Updated description
              unit_cost: '10.00000'
              unit_of_measure: HRS
    delete:
      operationId: deleteSubcontractClaimsBySubcontractClaimIdLineItemsBySubcontractClaimLineItemId
      summary: Delete Subcontract Claim Line Item
      tags:
      - Financials Management
      parameters:
      - name: subcontract_claim_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim.
      - name: subcontract_claim_line_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the subcontract claim line item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /tax-codes:
    get:
      operationId: getTaxCodes
      summary: List Tax Codes
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postTaxCodes
      summary: New Tax Code
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              code: SpaceMaterials
              name: SpaceMaterials...
  /tax-codes/{tax_code_id}:
    get:
      operationId: getTaxCodesByTaxCodeId
      summary: Show Tax Code
      tags:
      - Financials Management
      parameters:
      - name: tax_code_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the tax code.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    delete:
      operationId: deleteTaxCodesByTaxCodeId
      summary: Delete Tax Code
      tags:
      - Financials Management
      parameters:
      - name: tax_code_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the tax code.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putTaxCodesByTaxCodeId
      summary: Update Tax Code
      tags:
      - Financials Management
      parameters:
      - name: tax_code_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the tax code.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              code: SpaceMaterials
              name: SpaceMaterials...
  /timecard-entries:
    get:
      operationId: getTimecardEntries
      summary: List Timecard Entries
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postTimecardEntries
      summary: New Timecard Entry
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              batch: '20240728'
              cost_code_id: source_id:10000
              cost_type_id: source_id:LA
              date: '2024-01-15'
              description: JC Timecard from Postman 1
              earnings_type: Sick
              employee_id: '{{employee_id}}'
              hours: '10'
              payment_rate: '20.4'
              source_data:
                Reference_1: pcor-123
                GL_Debit_Account: '5050'
                GL_Credit_Account: '5400'
                Cost_Center_Credit: '1010'
  /timecard-entries/{timecard_entry_id}:
    get:
      operationId: getTimecardEntriesByTimecardEntryId
      summary: Show Timecard Entry
      tags:
      - Financials Management
      parameters:
      - name: timecard_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the timecard entry.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putTimecardEntriesByTimecardEntryId
      summary: Update Timecard Entry
      tags:
      - Financials Management
      parameters:
      - name: timecard_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the timecard entry.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: Sample timerard for {{$randomFullName}}
              date: '2023-06-03'
              hours: '89'
              status: Draft
    delete:
      operationId: deleteTimecardEntriesByTimecardEntryId
      summary: Delete Timecard Entry
      tags:
      - Financials Management
      parameters:
      - name: timecard_entry_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the timecard entry.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /wbs:
    get:
      operationId: getWbs
      summary: List WBS
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postWbs
      summary: New WBS
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              code: 01-000000.L
              name: Test WBS
  /wbs/{wbs_id}:
    get:
      operationId: getWbsByWbsId
      summary: Show WBS
      tags:
      - Financials Management
      parameters:
      - name: wbs_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /wbs-segments/{wbs_segment_id}/items:
    post:
      operationId: postWbsSegmentsByWbsSegmentIdItems
      summary: New WBS Segment Item
      tags:
      - Financials Management
      parameters:
      - name: wbs_segment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              code: 01-01-005
              name: Project Executive
              parent_id: '{{wbs_segment_item_id}}'
    get:
      operationId: getWbsSegmentsByWbsSegmentIdItems
      summary: List WBS Segment Items
      tags:
      - Financials Management
      parameters:
      - name: wbs_segment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /wbs-segments/{wbs_segment_id}/items/{wbs_segment_item_id}:
    put:
      operationId: putWbsSegmentsByWbsSegmentIdItemsByWbsSegmentItemId
      summary: Update WBS Segment Item
      tags:
      - Financials Management
      parameters:
      - name: wbs_segment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment.
      - name: wbs_segment_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              code: '129'
              name: test segment Value _renamed_
    get:
      operationId: getWbsSegmentsByWbsSegmentIdItemsByWbsSegmentItemId
      summary: Show WBS Segment Item
      tags:
      - Financials Management
      parameters:
      - name: wbs_segment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment.
      - name: wbs_segment_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    delete:
      operationId: deleteWbsSegmentsByWbsSegmentIdItemsByWbsSegmentItemId
      summary: Delete WBS Segment Item
      tags:
      - Financials Management
      parameters:
      - name: wbs_segment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment.
      - name: wbs_segment_item_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment item.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /wbs-segments:
    get:
      operationId: getWbsSegments
      summary: List WBS Segments
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postWbsSegments
      summary: New WBS Segment
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: TestType3
              source_data:
                structure: flat
  /wbs-segments/{wbs_segment_id}:
    get:
      operationId: getWbsSegmentsByWbsSegmentId
      summary: Show WBS Segment
      tags:
      - Financials Management
      parameters:
      - name: wbs_segment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    delete:
      operationId: deleteWbsSegmentsByWbsSegmentId
      summary: Delete WBS Segment
      tags:
      - Financials Management
      parameters:
      - name: wbs_segment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putWbsSegmentsByWbsSegmentId
      summary: Update WBS Segment
      tags:
      - Financials Management
      parameters:
      - name: wbs_segment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the wbs segment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              delimiter: hyphen
  /units-of-measure:
    get:
      operationId: getUnitsOfMeasure
      summary: List Units of Measure
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /units-of-measure/{unit_of_measure_id}:
    get:
      operationId: getUnitsOfMeasureByUnitOfMeasureId
      summary: Show Unit of Measure
      tags:
      - Financials Management
      parameters:
      - name: unit_of_measure_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the unit of measure.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /inventory-locations:
    get:
      operationId: getInventoryLocations
      summary: List Inventory Locations
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postInventoryLocations
      summary: New Inventory Location
      tags:
      - Financials Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              expense_account_id: '{{expense_account_id}}'
              income_account_id: '{{income_account_id}}'
              asset_account_id: '{{asset_account_id}}'
              name: Test Child Item
              status: Active
              type: Service
              unit_cost: '1.33'
              unit_price: '2.33'
  /inventory-locations/{inventory_location_id}:
    get:
      operationId: getInventoryLocationsByInventoryLocationId
      summary: Show Inventory Location
      tags:
      - Financials Management
      parameters:
      - name: inventory_location_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the inventory location.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putInventoryLocationsByInventoryLocationId
      summary: Update Inventory Location
      tags:
      - Financials Management
      parameters:
      - name: inventory_location_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the inventory location.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              account_id: b6cc53c8-ae13-5b9c-96e9-2287229b6a54
              description: Concrete for fountain installation
              name: Concrete 6
              status: Active
              unit_price: '12'
    delete:
      operationId: deleteInventoryLocationsByInventoryLocationId
      summary: Delete Inventory Location
      tags:
      - Financials Management
      parameters:
      - name: inventory_location_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the inventory location.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /departments:
    get:
      operationId: getDepartments
      summary: List Departments
      tags:
      - Financials Management
      parameters:
      - name: type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /departments/{department_id}:
    get:
      operationId: getDepartmentsByDepartmentId
      summary: Show Department
      tags:
      - Financials Management
      parameters:
      - name: department_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the department.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /projects:
    get:
      operationId: getProjects
      summary: List Projects
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postProjects
      summary: New Project
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                street_1: 123 Main Street
                street_2: Unit B
                city: AnyTown
                state: CA
                postal_code: '19703'
              amount: '500000.00'
              completion_date: '2025-01-01'
              name: AnyCompany dredging Project
              number: JZ-102
              start_date: '2022-01-01'
              status: Active
              type: Fixed Price
              source_data:
                Taxable_Flag: Y
                Cost_Center: '1010'
  /projects/{project_id}:
    get:
      operationId: getProjectsByProjectId
      summary: Show Project
      tags:
      - Project Management
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the project.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putProjectsByProjectId
      summary: Update Project
      tags:
      - Project Management
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the project.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: Test update 2
              number: PA-001
    delete:
      operationId: deleteProjectsByProjectId
      summary: Delete Project
      tags:
      - Project Management
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the project.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /checklists:
    get:
      operationId: getChecklists
      summary: List Checklists
      tags:
      - Project Management
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /checklists/{checklist_id}:
    get:
      operationId: getChecklistsByChecklistId
      summary: Show Checklist
      tags:
      - Project Management
      parameters:
      - name: checklist_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the checklist.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /checklist-templates:
    get:
      operationId: getChecklistTemplates
      summary: List Checklist Templates
      tags:
      - Project Management
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              filters:
              - field: type
                operator: '='
                value: Punch List
  /checklist-templates/{checklist_template_id}:
    get:
      operationId: getChecklistTemplatesByChecklistTemplateId
      summary: Show Checklist Template
      tags:
      - Project Management
      parameters:
      - name: checklist_template_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the checklist template.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /contacts:
    get:
      operationId: getContacts
      summary: List Contacts (Company)
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postContacts
      summary: New Contact (Company)
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                city: San Francisco2
                country: USA2
                postal_code: '6666667'
                state: CA2
                street_1: street3
              customer_id: null
              email: email223@email.com
              first_name: name6
              image_url: test.com/logo.png
              job_title: Salesperson
              last_name: lastname
              phone: 1-666-666-6668
  /vendors/{vendor_id}/contacts:
    get:
      operationId: getVendorsByVendorIdContacts
      summary: List Contacts (Vendor)
      tags:
      - Project Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /customers/{customer_id}/contacts:
    get:
      operationId: getCustomersByCustomerIdContacts
      summary: List Contacts (Customer)
      tags:
      - Project Management
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the customer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postCustomersByCustomerIdContacts
      summary: New Contact (Customer)
      tags:
      - Project Management
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the customer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              email: test-1@agaveapitest.com
              full_name: Test {{$randomFullName}}
              job_title: Salesperson
              mobile_phone: '1235550101'
              phone: '1235550102'
  /contacts/{contact_id}:
    get:
      operationId: getContactsByContactId
      summary: Show Contact (Company)
      tags:
      - Project Management
      parameters:
      - name: contact_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the contact.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putContactsByContactId
      summary: Update Contact (Company)
      tags:
      - Project Management
      parameters:
      - name: contact_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the contact.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                city: San Francisco2
                country: USA2
                postal_code: '6666667'
                state: CA2
                street_1: street3
              customer_id: null
              email: email223@email.com
              first_name: name6
              image_url: test.com/logo.png
              job_title: Salesperson
              last_name: lastname
              phone: 1-666-666-6668
    delete:
      operationId: deleteContactsByContactId
      summary: Delete Contact (Company)
      tags:
      - Project Management
      parameters:
      - name: contact_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the contact.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /vendors/{vendor_id}/contacts/{contact_id}:
    get:
      operationId: getVendorsByVendorIdContactsByContactId
      summary: Show Contact (Vendor)
      tags:
      - Project Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      - name: contact_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the contact.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /customers/{customer_id}/contacts/{contact_id}:
    get:
      operationId: getCustomersByCustomerIdContactsByContactId
      summary: Show Contact (Customer)
      tags:
      - Project Management
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the customer.
      - name: contact_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the contact.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putCustomersByCustomerIdContactsByContactId
      summary: Update Contact (Customer)
      tags:
      - Project Management
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the customer.
      - name: contact_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the contact.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                city: San Francisco2
                country: USA2
                postal_code: '6666667'
                state: CA2
                street_1: street3
              customer_id: null
              email: email223@email.com
              first_name: name6
              image_url: test.com/logo.png
              job_title: Salesperson
              last_name: lastname
              phone: 1-666-666-6668
    delete:
      operationId: deleteCustomersByCustomerIdContactsByContactId
      summary: Delete Contact (Customer)
      tags:
      - Project Management
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the customer.
      - name: contact_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the contact.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /coordination-issues:
    get:
      operationId: getCoordinationIssues
      summary: List Coordination Issues
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postCoordinationIssues
      summary: New Coordination Issue
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /coordination-issues/{coordination_issue_id}:
    get:
      operationId: getCoordinationIssuesByCoordinationIssueId
      summary: Show Coordination Issue
      tags:
      - Project Management
      parameters:
      - name: coordination_issue_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the coordination issue.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putCoordinationIssuesByCoordinationIssueId
      summary: Update Coordination Issue
      tags:
      - Project Management
      parameters:
      - name: coordination_issue_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the coordination issue.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              assignee_id: '{{contact_id}}'
              description: Updated Description
              due_date: '2022-12-25'
              name: Updated Title 2
              status: Open
              type: Issue
    delete:
      operationId: deleteCoordinationIssuesByCoordinationIssueId
      summary: Delete Coordination Issue
      tags:
      - Project Management
      parameters:
      - name: coordination_issue_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the coordination issue.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /coordination-issues/{coordination_issue_id}/attachments:
    post:
      operationId: postCoordinationIssuesByCoordinationIssueIdAttachments
      summary: New Attachment
      tags:
      - Project Management
      parameters:
      - name: coordination_issue_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the coordination issue.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /coordination-issues/{coordination_issue_id}/viewpoints:
    post:
      operationId: postCoordinationIssuesByCoordinationIssueIdViewpoints
      summary: New Viewpoint
      tags:
      - Project Management
      parameters:
      - name: coordination_issue_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the coordination issue.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /drawings:
    get:
      operationId: getDrawings
      summary: List Drawings
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /drawings/{drawing_id}:
    get:
      operationId: getDrawingsByDrawingId
      summary: Show Drawing
      tags:
      - Project Management
      parameters:
      - name: drawing_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the drawing.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /drawings/{drawing_id}/versions:
    get:
      operationId: getDrawingsByDrawingIdVersions
      summary: List Drawing Versions
      tags:
      - Project Management
      parameters:
      - name: drawing_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the drawing.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /drawings/{drawing_id}/versions/{drawing_version_id}:
    get:
      operationId: getDrawingsByDrawingIdVersionsByDrawingVersionId
      summary: Show Drawing Version
      tags:
      - Project Management
      parameters:
      - name: drawing_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the drawing.
      - name: drawing_version_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the drawing version.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /drawing-areas:
    get:
      operationId: getDrawingAreas
      summary: List Drawing Areas
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /drawing-areas/{drawing_area_id}:
    get:
      operationId: getDrawingAreasByDrawingAreaId
      summary: Show Drawing Folder
      tags:
      - Project Management
      parameters:
      - name: drawing_area_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the drawing area.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /issues:
    get:
      operationId: getIssues
      summary: List Issues
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /locations:
    get:
      operationId: getLocations
      summary: List Locations
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /locations/{location_id}:
    get:
      operationId: getLocationsByLocationId
      summary: Show Location
      tags:
      - Project Management
      parameters:
      - name: location_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the location.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /observations:
    get:
      operationId: getObservations
      summary: List Observations
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postObservations
      summary: New Observation
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              assignee_id: '{{user_id}}'
              description: austin test description
              due_date: '2022-03-25'
              name: austin test observation 2
              location_id: '{{location_id}}'
              root_cause: Communication
              status: initiated
              type: Commissioning
              source_data:
                priority: Medium
  /observations/{observation_id}:
    get:
      operationId: getObservationsByObservationId
      summary: Show Observation
      tags:
      - Project Management
      parameters:
      - name: observation_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the observation.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putObservationsByObservationId
      summary: Update Observation
      tags:
      - Project Management
      parameters:
      - name: observation_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the observation.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              assignee_id: '{{user_id}}'
              description: pooria test description
              due_date: '2022-03-25'
              name: pooria test observation 2
              location_id: '{{location_id}}'
              root_cause: Communication
              status: closed
              type: Commissioning
    delete:
      operationId: deleteObservationsByObservationId
      summary: Delete Observation
      tags:
      - Project Management
      parameters:
      - name: observation_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the observation.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /observations/{observation_id}/attachments:
    post:
      operationId: postObservationsByObservationIdAttachments
      summary: New Attachment
      tags:
      - Project Management
      parameters:
      - name: observation_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the observation.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /rfis:
    get:
      operationId: getRfis
      summary: List RFIs
      tags:
      - Project Management
      parameters:
      - name: expand
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postRfis
      summary: New RFI
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              subject: Unexpected pipe near side window
              creator_id: '{{user_id}}'
              cost_impact:
                code: USD
                amount: '1240.60'
              assignee_ids:
              - '{{user_id}}'
              question: see title
              number: R-{{$randomInt}}
              due_date: '2022-09-07'
  /rfis/{rfi_id}:
    get:
      operationId: getRfisByRfiId
      summary: Show RFI
      tags:
      - Project Management
      parameters:
      - name: rfi_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the rfi.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /rfis/{rfi_id}/attachments:
    post:
      operationId: postRfisByRfiIdAttachments
      summary: New Attachment
      tags:
      - Project Management
      parameters:
      - name: rfi_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the rfi.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /rfis/{rfi_id}/responses:
    post:
      operationId: postRfisByRfiIdResponses
      summary: New RFI Response
      tags:
      - Project Management
      parameters:
      - name: rfi_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the rfi.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              creator_id: '{{user_id}}'
              text: on the third floor!!
              is_official: true
  /specification-sections:
    get:
      operationId: getSpecificationSections
      summary: List Specification Sections
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /specification-sections/{specification_section_id}:
    get:
      operationId: getSpecificationSectionsBySpecificationSectionId
      summary: Show Specification Section
      tags:
      - Project Management
      parameters:
      - name: specification_section_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the specification section.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /specification-sections/{specification_section_id}/versions:
    get:
      operationId: getSpecificationSectionsBySpecificationSectionIdVersions
      summary: List Specification Section Versions
      tags:
      - Project Management
      parameters:
      - name: specification_section_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the specification section.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /specification-sections/{specification_section_id}/versions/{specification_section_version_id}:
    get:
      operationId: getSpecificationSectionsBySpecificationSectionIdVersionsBySpecificationSectionVersionId
      summary: Show Specification Section Version
      tags:
      - Project Management
      parameters:
      - name: specification_section_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the specification section.
      - name: specification_section_version_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the specification section version.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /submittals:
    get:
      operationId: getSubmittals
      summary: List Submittals
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postSubmittals
      summary: New Submittal
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: austin test description
              distribution_contacts:
              - '{{contact_id}}'
              name: pooria test name
              number: '12345'
              package_id: '{{submittal_package_id}}'
              reviewers:
              - - role: Submitter
                  contact_id: '{{contact_id}}'
                - role: Approver
                  contact_id: '{{contact_id}}'
                  due_date: '2022-12-30'
              - - role: Approver
                  contact_id: '{{contact_id}}'
                  due_date: '2022-12-31'
              - - role: Submitter
                  contact_id: '{{contact_id}}'
                  due_date: '2022-12-31'
              status: Draft
              type: pooria test type
  /submittals/{submittal_id}:
    get:
      operationId: getSubmittalsBySubmittalId
      summary: Show Submittal
      tags:
      - Project Management
      parameters:
      - name: submittal_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the submittal.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putSubmittalsBySubmittalId
      summary: Update Submittal
      tags:
      - Project Management
      parameters:
      - name: submittal_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the submittal.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              number: '12345'
              name: pooria update name
              reviewers:
              - - id: 73b5249c-cd07-5818-9e94-129de83940ba
                  review_status: Revise and Resubmit
  /submittals/{submittal_id}/attachments:
    post:
      operationId: postSubmittalsBySubmittalIdAttachments
      summary: Attach to Submittal
      tags:
      - Project Management
      parameters:
      - name: submittal_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the submittal.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /submittals/{submittal_id}/submittal-reviewers/{id}/attachments:
    post:
      operationId: postSubmittalsBySubmittalIdSubmittalReviewersByIdAttachments
      summary: Attach to Submittal Reviewer
      tags:
      - Project Management
      parameters:
      - name: submittal_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the submittal.
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the id.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /submittals/{id}:
    delete:
      operationId: deleteSubmittalsById
      summary: Delete Submittal
      tags:
      - Project Management
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the id.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /submittal-packages:
    get:
      operationId: getSubmittalPackages
      summary: List Submittal Packages
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postSubmittalPackages
      summary: New Submittal Package
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: austin test description
              name: austin test name
              number: '12345'
              submittal_ids: []
  /submittal-packages/{submittal_package_id}:
    get:
      operationId: getSubmittalPackagesBySubmittalPackageId
      summary: Show Submittal Package
      tags:
      - Project Management
      parameters:
      - name: submittal_package_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the submittal package.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putSubmittalPackagesBySubmittalPackageId
      summary: Update Submittal Package
      tags:
      - Project Management
      parameters:
      - name: submittal_package_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the submittal package.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: austin test description
              name: austin test name
              number: '12345'
              submittal_ids:
              - '{{submittal_id}}'
  /submittal-packages/{id}:
    delete:
      operationId: deleteSubmittalPackagesById
      summary: Delete Submittal Package
      tags:
      - Project Management
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the id.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /transmittals:
    get:
      operationId: getTransmittals
      summary: List Transmittals
      tags:
      - Project Management
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              filters:
              - field: sent_date
                operator: '>='
                value: '2022-07-20'
  /transmittals/{transmittal_id}:
    get:
      operationId: getTransmittalsByTransmittalId
      summary: Show Transmittal
      tags:
      - Project Management
      parameters:
      - name: transmittal_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the transmittal.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /vendors:
    get:
      operationId: getVendors
      summary: List Vendors (Company)
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postVendors
      summary: New Vendor
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                street_1: '{{$randomStreetName}}'
                city: '{{$randomCity}}'
                state: CA
                postal_code: '89434'
              phone: '{{$randomPhoneNumber}}'
              name: PA {{$randomCompanyName}}
              website: '{{$randomUrl}}'
    patch:
      operationId: patchVendors
      summary: Bulk Write Vendors
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              creates:
              - address:
                  street_1: Fave Street 1
                  country: US
                  city: San Francisco 1
                  postal_code: '11111'
                alternate_name: Test 1
                email: email2@email.com
                fax: 1-111-111-1111
                name: Liam Test 1
                phone: 1-111-222-1111
                tax_number: '111111111'
                website: https://www.liamtest1.com
                source_data:
                  business_register:
                    type: ein
              - name: Liam vendor that should fail
                source_data:
                  business_phone: asdfasdfasdfasdfasdf
              - address:
                  street_1: Fave Street 2
                  country: US
                  city: San Francisco 2
                  postal_code: '22222'
                alternate_name: Test 2
                email: email2@email.com
                fax: 1-222-222-22222
                name: Liam Test 1
                phone: 1-222-111-22222
                tax_number: '222222222'
                website: https://www.liamtest2.com
                source_data:
                  business_register:
                    type: ein
              updates:
              - id: source_id:234128
                email: contact+edited1@agaveapi.com
              - id: source_id:123123123123123
                name: Update should Fail
              - id: source_id:234210
                email: contact+edited2@agaveapi.com
  /vendors/{vendor_id}:
    get:
      operationId: getVendorsByVendorId
      summary: Show Vendor
      tags:
      - Project Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    delete:
      operationId: deleteVendorsByVendorId
      summary: Delete Project Vendor
      tags:
      - Project Management
      parameters:
      - name: vendor_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the vendor.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /vendors/source_id:3404938:
    put:
      operationId: putVendorsSourceId3404938
      summary: Update Vendor
      tags:
      - Project Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: Vendor from Brazil (updated)
              source_data:
                BpvenPayContactName: Vendor from Brazil (updated)
                BpvenShpinstDesc: Vendor from Brazil (updated)
  /work-logs:
    get:
      operationId: getWorkLogs
      summary: List Work Logs
      tags:
      - Project Management
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /root-folder:
    get:
      operationId: getRootFolder
      summary: Show Root Folder
      tags:
      - File Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /folders/{folder_id}:
    get:
      operationId: getFoldersByFolderId
      summary: Show Folder
      tags:
      - File Management
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the folder.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putFoldersByFolderId
      summary: Update Folder
      tags:
      - File Management
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the folder.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: test rename
    delete:
      operationId: deleteFoldersByFolderId
      summary: Delete Folder
      tags:
      - File Management
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the folder.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /folders:
    post:
      operationId: postFolders
      summary: New Folder
      tags:
      - File Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: 01 Design Files
              parent_id: '{{folder_id}}'
  /folders/{folder_id}/files:
    get:
      operationId: getFoldersByFolderIdFiles
      summary: List Files in Folder
      tags:
      - File Management
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the folder.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postFoldersByFolderIdFiles
      summary: Upload File
      tags:
      - File Management
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the folder.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /files/{file_id}:
    get:
      operationId: getFilesByFileId
      summary: Show File
      tags:
      - File Management
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putFilesByFileId
      summary: Update File
      tags:
      - File Management
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: new-name.pdf
    delete:
      operationId: deleteFilesByFileId
      summary: Delete File
      tags:
      - File Management
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /folders/{folder_id}/transfer:
    post:
      operationId: postFoldersByFolderIdTransfer
      summary: Transfer To New File
      tags:
      - File Management
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the folder.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              source:
                url: https://dc-lidar-2018.s3.amazonaws.com/Classified_LAS/2007.las
              target:
                name: 132421.las
                content_type: application/object
  /files/{file_id}/transfer:
    post:
      operationId: postFilesByFileIdTransfer
      summary: Transfer To Existing File
      tags:
      - File Management
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              source:
                url: https://www.agaveapi.com/assets/img/link/logo-square-dropbox.png
              target:
                name: random file.png
                content_type: image/png
  /file-transfers/{file_transfer_id}:
    get:
      operationId: getFileTransfersByFileTransferId
      summary: Transfer File Status
      tags:
      - File Management
      parameters:
      - name: file_transfer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file transfer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /files/{file_id}/versions:
    get:
      operationId: getFilesByFileIdVersions
      summary: List File Versions
      tags:
      - File Management
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postFilesByFileIdVersions
      summary: Upload File Version
      tags:
      - File Management
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /files/{file_id}/versions/{file_version_id}:
    get:
      operationId: getFilesByFileIdVersionsByFileVersionId
      summary: Show File Version
      tags:
      - File Management
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file.
      - name: file_version_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the file version.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /photos:
    get:
      operationId: getPhotos
      summary: List Photos
      tags:
      - File Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postPhotos
      summary: Upload Photo
      tags:
      - File Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /photos/{photo_id}:
    get:
      operationId: getPhotosByPhotoId
      summary: Show Photo
      tags:
      - File Management
      parameters:
      - name: photo_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the photo.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putPhotosByPhotoId
      summary: Update Photo
      tags:
      - File Management
      parameters:
      - name: photo_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the photo.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: updated description
    delete:
      operationId: deletePhotosByPhotoId
      summary: Delete Photo
      tags:
      - File Management
      parameters:
      - name: photo_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the photo.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /activities:
    get:
      operationId: getActivities
      summary: List Activities
      tags:
      - Customer Management
      parameters:
      - name: type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postActivities
      summary: New Activity
      tags:
      - Customer Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: '<div style="white-space: pre-wrap;" dir="auto" data-top-level="false"><p style="margin-bottom:0;">test</p></div>'
              activity_time: '2023-01-05T06:57:01Z'
              type: note
  /activities/{activity_id}:
    get:
      operationId: getActivitiesByActivityId
      summary: Show Activity
      tags:
      - Customer Management
      parameters:
      - name: activity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the activity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putActivitiesByActivityId
      summary: Update Activity
      tags:
      - Customer Management
      parameters:
      - name: activity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the activity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              description: <strong>HTML test</strong> hello
              time_time: '2023-01-05T06:57:11Z'
              source_data:
                properties:
                  hs_attachment_ids: '{{source_attachment_id}}'
    delete:
      operationId: deleteActivitiesByActivityId
      summary: Delete Activity
      tags:
      - Customer Management
      parameters:
      - name: activity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the activity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /activities/{activity_id}/attachments:
    post:
      operationId: postActivitiesByActivityIdAttachments
      summary: New Attachment
      tags:
      - Customer Management
      parameters:
      - name: activity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the activity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /appointments:
    get:
      operationId: getAppointments
      summary: List Appointments
      tags:
      - Customer Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /appointments/{appointment_id}:
    get:
      operationId: getAppointmentsByAppointmentId
      summary: Show Appointment
      tags:
      - Customer Management
      parameters:
      - name: appointment_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the appointment.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /customers:
    get:
      operationId: getCustomers
      summary: List Customers
      tags:
      - Customer Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postCustomers
      summary: New Customer
      tags:
      - Customer Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: Current Properties Inc.
              source_data:
                ClientStatusRef:
                  ObjectID: '3'
  /customers/{customer_id}:
    get:
      operationId: getCustomersByCustomerId
      summary: Show Customer
      tags:
      - Customer Management
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the customer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putCustomersByCustomerId
      summary: Update Customer
      tags:
      - Customer Management
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the customer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              addresses:
              - street_1: 123 Main Street
                street_2: Unit 1
                city: AnyTown
                state: CA
                country: US
                postal_code: '19703'
              email: contact@agaveapi.com
              name: AnyCompany 10.
              phone: (123) 555-0100
              status: Active
              website: https://agaveapi.com/
              tax_code_id: source_id:CA
              terms: Net 30 days
    delete:
      operationId: deleteCustomersByCustomerId
      summary: Delete Customer
      tags:
      - Customer Management
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the customer.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /leads:
    get:
      operationId: getLeads
      summary: List Leads
      tags:
      - Customer Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /leads/{lead_id}:
    get:
      operationId: getLeadsByLeadId
      summary: Show Lead
      tags:
      - Customer Management
      parameters:
      - name: lead_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the lead.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /opportunities:
    get:
      operationId: getOpportunities
      summary: List Opportunites
      tags:
      - Customer Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postOpportunities
      summary: New Opportunity
      tags:
      - Customer Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: 150000
              close_date: '2022-12-01'
              contact_ids:
              - '{{contact_id}}'
              customer_ids:
              - '{{customer_id}}'
              description: DESC.
              name: 123 Apartment Project
              probability: 0.1
              stage: qualifiedtobuy
              type: newbusiness
  /opportunities/{opportunity_id}:
    get:
      operationId: getOpportunitiesByOpportunityId
      summary: Show Opportunity
      tags:
      - Customer Management
      parameters:
      - name: opportunity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the opportunity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putOpportunitiesByOpportunityId
      summary: Update Opportunity
      tags:
      - Customer Management
      parameters:
      - name: opportunity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the opportunity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              amount: 999
              close_date: '2022-09-14T12:20:20.111Z'
              creator_id: null
              customer_ids:
              - 8f2bce00-88ac-58ed-876b-c2dfe0615777
              - 5f491f30-bb50-5817-8162-8220b9288c3c
              stage: qualifiedtobuy
    delete:
      operationId: deleteOpportunitiesByOpportunityId
      summary: Delete Opportunity
      tags:
      - Customer Management
      parameters:
      - name: opportunity_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the opportunity.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /jobs:
    get:
      operationId: getJobs
      summary: List Jobs
      tags:
      - Service Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /jobs/{job_id}:
    get:
      operationId: getJobsByJobId
      summary: Show Job
      tags:
      - Service Management
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the job.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /work-orders:
    get:
      operationId: getWorkOrders
      summary: List Work Orders
      tags:
      - Service Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postWorkOrders
      summary: New Work Order
      tags:
      - Service Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /work-orders/{work_order_id}:
    get:
      operationId: getWorkOrdersByWorkOrderId
      summary: Show Work Order
      tags:
      - Service Management
      parameters:
      - name: work_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the work order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putWorkOrdersByWorkOrderId
      summary: Update Work Order
      tags:
      - Service Management
      parameters:
      - name: work_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the work order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              contact_name: Jack
              contact_phone: '42155512345'
              description: Update Title
              order_date: '2024-02-10'
              request_date: '2024-02-11'
              request_time_of_day: '12:22'
              technician_employee_id: source_id:2
              source_data:
                RequestedBy: API
                Certified: Y
                Notes: Extra notes
    delete:
      operationId: deleteWorkOrdersByWorkOrderId
      summary: Delete Work Order
      tags:
      - Service Management
      parameters:
      - name: work_order_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the work order.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /service-sites:
    get:
      operationId: getServiceSites
      summary: List Service Sites
      tags:
      - Service Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postServiceSites
      summary: New Service Site
      tags:
      - Service Management
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              address:
                city: Springfield
                postal_code: '62701'
                state: IL
                street_1: 1234 Elm Street
                street_2: Apt 5B
              code: '5'
              customer_id: source_id:145
              name: Main Office
              tax_code_id: source_id:1
  /service-sites/{service_site_id}:
    get:
      operationId: getServiceSitesByServiceSiteId
      summary: Show Service Site
      tags:
      - Service Management
      parameters:
      - name: service_site_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the service site.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    put:
      operationId: putServiceSitesByServiceSiteId
      summary: Update Service Site
      tags:
      - Service Management
      parameters:
      - name: service_site_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the service site.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              contact_name: Jack
              contact_phone: '42155512345'
              description: Update Title
              order_date: '2024-02-10'
              request_date: '2024-02-11'
              request_time_of_day: '12:22'
              technician_employee_id: source_id:2
              source_data:
                RequestedBy: API
                Certified: Y
                Notes: Extra notes
    delete:
      operationId: deleteServiceSitesByServiceSiteId
      summary: Delete Service Site
      tags:
      - Service Management
      parameters:
      - name: service_site_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the service site.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
  /webhooks:
    get:
      operationId: getWebhooks
      summary: List Webhooks
      tags:
      - Webhooks
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    post:
      operationId: postWebhooks
      summary: New Webhook
      tags:
      - Webhooks
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              callback_url: https://webhook.site/246a1376-0023-45f7-b685-1fbe9634a8b8
              event: UPDATE
              type: submittal
  /webhooks/{webhook_id}:
    get:
      operationId: getWebhooksByWebhookId
      summary: Show Webhook
      tags:
      - Webhooks
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the webhook.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
    delete:
      operationId: deleteWebhooksByWebhookId
      summary: Delete Webhook
      tags:
      - Webhooks
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
        description: Agave identifier for the webhook.
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized - missing or invalid Client-Id / Client-Secret / Account-Token / API-Version
            header
        '429':
          description: Too Many Requests - Agave or source-system rate limit reached
components:
  securitySchemes:
    ClientId:
      type: apiKey
      in: header
      name: Client-Id
      description: 36-character UUID client identifier.
    ClientSecret:
      type: apiKey
      in: header
      name: Client-Secret
      description: 40-character client secret.
    AccountToken:
      type: apiKey
      in: header
      name: Account-Token
      description: Account Token for the linked user account.