openapi: 3.0.3
info:
  title: 'Vendor Portal'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://vendors.getlinkk.com'
paths:
  /api/v1/billing-locations:
    get:
      summary: 'Retrieve main list of billing locations'
      operationId: retrieveMainListOfBillingLocations
      description: 'Provide any of the following values for the customer_id field to identify and filter by customer: id, FEIN, vendor_number.'
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of elements per page. Defaults to 15.'
          example: 7
          required: false
          schema:
            type: integer
            description: 'Number of elements per page. Defaults to 15.'
            example: 7
        -
          in: query
          name: before
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-23 12:00:00'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-23 12:00:00'
        -
          in: query
          name: after
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-01'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      current_page: 1
                      data: []
                      first_page_url: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      from: null
                      last_page: 1
                      last_page_url: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      links:
                        -
                          url: null
                          label: '&laquo; Previous'
                          active: false
                        -
                          url: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                          label: '1'
                          active: true
                        -
                          url: null
                          label: 'Next &raquo;'
                          active: false
                      next_page_url: null
                      path: 'https://vendors.getlinkk.com/api/v1/billing-locations'
                      per_page: 7
                      prev_page_url: null
                      to: null
                      total: 0
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        current_page: 1
                        data: []
                        first_page_url: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from: null
                        last_page: 1
                        last_page_url: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        next_page_url: null
                        path: 'https://vendors.getlinkk.com/api/v1/billing-locations'
                        per_page: 7
                        prev_page_url: null
                        to: null
                        total: 0
                    items:
                      type: object
                      properties:
                        current_page:
                          type: integer
                          example: 1
                        data:
                          type: array
                          example: []
                        first_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from:
                          type: string
                          example: null
                        last_page:
                          type: integer
                          example: 1
                        last_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          type: array
                          example:
                            -
                              url: null
                              label: '&laquo; Previous'
                              active: false
                            -
                              url: 'https://vendors.getlinkk.com/api/v1/billing-locations?customer_id=maxime&per_page=7&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                              label: '1'
                              active: true
                            -
                              url: null
                              label: 'Next &raquo;'
                              active: false
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              label:
                                type: string
                                example: '&laquo; Previous'
                              active:
                                type: boolean
                                example: false
                        next_page_url:
                          type: string
                          example: null
                        path:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/billing-locations'
                        per_page:
                          type: integer
                          example: 7
                        prev_page_url:
                          type: string
                          example: null
                        to:
                          type: string
                          example: null
                        total:
                          type: integer
                          example: 0
      tags:
        - 'Billing Locations'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  description: ''
                  example: maxime
    post:
      summary: 'Billing location creation'
      operationId: billingLocationCreation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Billing Locations'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: aqvtex
                contact_name:
                  type: string
                  description: 'Must not be greater than 150 characters.'
                  example: 'John Smith'
                contact_title:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: 'Senior Sales Representative'
                contact_phone:
                  type: string
                  description: 'Must not be greater than 50 characters.'
                  example: 202-555-0160
                address:
                  type: string
                  description: 'Must not be greater than 250 characters.'
                  example: '4306 Hott Street'
                billing_account:
                  type: string
                  description: 'Must not be greater than 250 characters.'
                  example: svdnjg
                contact_emails:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                service_areas:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                service_types:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                customer_id:
                  type: string
                  description: 'The customer that the billing location will belong to. Provide any of the following values to identify the customer: id, FEIN, vendor_number.'
                  example: '123456789'
                city:
                  type: string
                  description: 'Must match the regex /(^[A-Za-z ]+$)+/. Must not be greater than 100 characters.'
                  example: 'Oklahoma City'
                state:
                  type: string
                  description: ''
                  example: Oklahoma
                zip_code:
                  type: string
                  description: 'Must be 5 characters.'
                  example: '12345'
              required:
                - name
                - customer_id
                - city
  '/api/v1/billing-locations/{identifier}':
    patch:
      summary: 'Billing location update'
      operationId: billingLocationUpdate
      description: 'Active status changes will be ignored. Please use the archive and activate endpoints for that purpose.'
      parameters: []
      responses: {  }
      tags:
        - 'Billing Locations'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 150 characters.'
                  example: jbqhsklus
                contact_name:
                  type: string
                  description: 'Must not be greater than 150 characters.'
                  example: 'John Smith'
                contact_title:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: 'Senior Sales Representative'
                contact_phone:
                  type: string
                  description: 'Must not be greater than 50 characters.'
                  example: 202-555-0160
                address:
                  type: string
                  description: 'Must not be greater than 250 characters.'
                  example: '4306 Hott Street'
                billing_account:
                  type: string
                  description: 'Must not be greater than 250 characters.'
                  example: tzfqtfxckbncrhexfnklo
                contact_emails:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                service_areas:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                service_types:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                city:
                  type: string
                  description: 'Must match the regex /(^[A-Za-z ]+$)+/. Must not be greater than 100 characters.'
                  example: 'Oklahoma City'
                state:
                  type: string
                  description: ''
                  example: Oklahoma
                zip_code:
                  type: string
                  description: 'Must be 5 characters.'
                  example: '12345'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the billing location to be updated: id, billing_account.'
        example: sint
        required: true
        schema:
          type: string
  '/api/v1/billing-locations/{identifier}/archive':
    patch:
      summary: 'Billing location archive'
      operationId: billingLocationArchive
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Billing Locations'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the billing location to be archived: id, billing_account.'
        example: rerum
        required: true
        schema:
          type: string
  '/api/v1/billing-locations/{identifier}/activate':
    patch:
      summary: 'Billing location activate'
      operationId: billingLocationActivate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Billing Locations'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the billing location to be (re)activated: id, billing_account.'
        example: fuga
        required: true
        schema:
          type: string
  /api/v1/customers:
    get:
      summary: 'Retrieve main list of customers'
      operationId: retrieveMainListOfCustomers
      description: ''
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of elements per page. Defaults to 15.'
          example: 14
          required: false
          schema:
            type: integer
            description: 'Number of elements per page. Defaults to 15.'
            example: 14
        -
          in: query
          name: before
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-23 12:00:00'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-23 12:00:00'
        -
          in: query
          name: after
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-01'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      current_page: 1
                      data: []
                      first_page_url: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      from: null
                      last_page: 1
                      last_page_url: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      links:
                        -
                          url: null
                          label: '&laquo; Previous'
                          active: false
                        -
                          url: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                          label: '1'
                          active: true
                        -
                          url: null
                          label: 'Next &raquo;'
                          active: false
                      next_page_url: null
                      path: 'https://vendors.getlinkk.com/api/v1/customers'
                      per_page: 14
                      prev_page_url: null
                      to: null
                      total: 0
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        current_page: 1
                        data: []
                        first_page_url: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from: null
                        last_page: 1
                        last_page_url: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        next_page_url: null
                        path: 'https://vendors.getlinkk.com/api/v1/customers'
                        per_page: 14
                        prev_page_url: null
                        to: null
                        total: 0
                    items:
                      type: object
                      properties:
                        current_page:
                          type: integer
                          example: 1
                        data:
                          type: array
                          example: []
                        first_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from:
                          type: string
                          example: null
                        last_page:
                          type: integer
                          example: 1
                        last_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          type: array
                          example:
                            -
                              url: null
                              label: '&laquo; Previous'
                              active: false
                            -
                              url: 'https://vendors.getlinkk.com/api/v1/customers?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                              label: '1'
                              active: true
                            -
                              url: null
                              label: 'Next &raquo;'
                              active: false
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              label:
                                type: string
                                example: '&laquo; Previous'
                              active:
                                type: boolean
                                example: false
                        next_page_url:
                          type: string
                          example: null
                        path:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/customers'
                        per_page:
                          type: integer
                          example: 14
                        prev_page_url:
                          type: string
                          example: null
                        to:
                          type: string
                          example: null
                        total:
                          type: integer
                          example: 0
      tags:
        - Customers
    post:
      summary: 'Customer creation'
      operationId: customerCreation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                insurance_expiration_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                msa_expiration_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                vendor_number:
                  type: string
                  description: 'Must contain only letters and numbers. Must not be greater than 20 characters.'
                  example: bruisqgkyzopb
                name:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: brj
                fein:
                  type: string
                  description: 'Must not be greater than 20 characters.'
                  example: '123456789'
                address:
                  type: string
                  description: ''
                  example: '4306 Hott Street'
                city:
                  type: string
                  description: 'Must match the regex /(^[A-Za-z ]+$)+/. Must not be greater than 100 characters.'
                  example: 'Oklahoma City'
                zip_code:
                  type: string
                  description: 'Must be 5 characters.'
                  example: '12345'
                contact_name:
                  type: string
                  description: 'Must be at least 3 characters. Must not be greater than 40 characters.'
                  example: 'John Smith'
                contact_title:
                  type: string
                  description: 'Must match the regex /(^[A-Za-z0-9 ]+$)+/. Must be at least 3 characters. Must not be greater than 30 characters.'
                  example: 'Senior Sales Representative'
                contact_phone:
                  type: string
                  description: ''
                  example: 202-555-0160
                contact_email:
                  type: string
                  description: 'Must be a valid email address.'
                  example: nikolaus.elenor@example.com
                requirements:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                customer_type:
                  type: string
                  description: 'The type of customer to be created, 0 being a Lease Location customer and 1 being a Physical Address customer. Defaults to 0.'
                  example: '0'
                  enum:
                    - '0'
                    - '1'
                credit_hold:
                  type: string
                  description: 'Determines if the customer is on credit hold. Defaults to 0.'
                  example: '0'
                  enum:
                    - '0'
                    - '1'
                billing_account:
                  type: string
                  description: ''
                  example: null
                service_area_id:
                  type: string
                  description: ''
                  example: null
                state:
                  type: string
                  description: ''
                  example: Oklahoma
              required:
                - vendor_number
                - name
                - fein
                - address
                - city
                - zip_code
  '/api/v1/customers/{identifier}':
    patch:
      summary: 'Customer update'
      operationId: customerUpdate
      description: 'Active status changes will be ignored. Please use the archive and activate endpoints for that purpose.'
      parameters: []
      responses: {  }
      tags:
        - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                insurance_expiration_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                msa_expiration_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                vendor_number:
                  type: string
                  description: 'Must contain only letters and numbers. Must not be greater than 20 characters.'
                  example: kzzlzlmtuzippnmk
                name:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: ctxrldeez
                fein:
                  type: string
                  description: 'Must not be greater than 20 characters.'
                  example: '123456789'
                address:
                  type: string
                  description: ''
                  example: '4306 Hott Street'
                city:
                  type: string
                  description: 'Must match the regex /(^[A-Za-z ]+$)+/. Must not be greater than 100 characters.'
                  example: 'Oklahoma City'
                zip_code:
                  type: string
                  description: 'Must be 5 characters.'
                  example: '12345'
                contact_name:
                  type: string
                  description: 'Must be at least 3 characters. Must not be greater than 40 characters.'
                  example: 'John Smith'
                contact_title:
                  type: string
                  description: 'Must match the regex /(^[A-Za-z0-9 ]+$)+/. Must be at least 3 characters. Must not be greater than 30 characters.'
                  example: 'Senior Sales Representative'
                contact_phone:
                  type: string
                  description: ''
                  example: 202-555-0160
                contact_email:
                  type: string
                  description: 'Must be a valid email address.'
                  example: brown20@example.org
                requirements:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                customer_type:
                  type: string
                  description: 'The type of customer to be created, 0 being a Lease Location customer and 1 being a Physical Address customer. Defaults to 0.'
                  example: '0'
                  enum:
                    - '0'
                    - '1'
                credit_hold:
                  type: string
                  description: 'Determines if the customer is on credit hold. Defaults to 0.'
                  example: '0'
                  enum:
                    - '0'
                    - '1'
                billing_account:
                  type: string
                  description: ''
                  example: null
                service_area_id:
                  type: string
                  description: ''
                  example: null
                state:
                  type: string
                  description: ''
                  example: Oklahoma
              required:
                - vendor_number
                - name
                - fein
                - address
                - city
                - zip_code
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the customer to be updated: id, FEIN, vendor_number.'
        example: '123456789'
        required: true
        schema:
          type: string
  '/api/v1/customers/{identifier}/archive':
    patch:
      summary: 'Customer archive'
      operationId: customerArchive
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Customers
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the customer to be archived: id, FEIN, vendor_number.'
        example: '123456789'
        required: true
        schema:
          type: string
  '/api/v1/customers/{identifier}/activate':
    patch:
      summary: 'Customer activate'
      operationId: customerActivate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Customers
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the customer to be (re)activated: id, FEIN, vendor_number.'
        example: '123456789'
        required: true
        schema:
          type: string
  /api/v1/submit-errors:
    post:
      summary: ''
      operationId: postApiV1SubmitErrors
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Endpoints
  /api/v1/jobs/custom-fields:
    get:
      summary: 'Job custom fields'
      operationId: jobCustomFields
      description: 'Type determines the value the field accepts: 0 means it can store any value, 1 means it will only accept a boolean (either true or false).'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      id: 10
                      name: 'Customer List Job Name'
                      min: null
                      max: null
                      required: 0
                      numeric: 0
                      date: 0
                      type: 0
                    -
                      id: 4
                      name: 'Location Pin'
                      min: null
                      max: null
                      required: 0
                      numeric: 0
                      date: 0
                      type: 0
                    -
                      id: 7
                      name: 'Purchase Order'
                      min: null
                      max: null
                      required: 0
                      numeric: 0
                      date: 0
                      type: 0
                    -
                      id: 6
                      name: 'SAP Ship To Account'
                      min: null
                      max: null
                      required: 0
                      numeric: 0
                      date: 0
                      type: 0
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        id: 10
                        name: 'Customer List Job Name'
                        min: null
                        max: null
                        required: 0
                        numeric: 0
                        date: 0
                        type: 0
                      -
                        id: 4
                        name: 'Location Pin'
                        min: null
                        max: null
                        required: 0
                        numeric: 0
                        date: 0
                        type: 0
                      -
                        id: 7
                        name: 'Purchase Order'
                        min: null
                        max: null
                        required: 0
                        numeric: 0
                        date: 0
                        type: 0
                      -
                        id: 6
                        name: 'SAP Ship To Account'
                        min: null
                        max: null
                        required: 0
                        numeric: 0
                        date: 0
                        type: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 10
                        name:
                          type: string
                          example: 'Customer List Job Name'
                        min:
                          type: string
                          example: null
                        max:
                          type: string
                          example: null
                        required:
                          type: integer
                          example: 0
                        numeric:
                          type: integer
                          example: 0
                        date:
                          type: integer
                          example: 0
                        type:
                          type: integer
                          example: 0
      tags:
        - Jobs
  /api/v1/jobs:
    get:
      summary: 'Retrieve main list of jobs'
      operationId: retrieveMainListOfJobs
      description: ''
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of elements per page. Defaults to 15.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of elements per page. Defaults to 15.'
            example: 10
        -
          in: query
          name: before
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-23 12:00:00'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-23 12:00:00'
        -
          in: query
          name: after
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-01'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      current_page: 1
                      data:
                        -
                          id: 5516
                          job_state: Production
                          spud_date: null
                          google_sheet_raw: null
                          operator: null
                          lease_name: 'Unit 2040 Cascade'
                          well_number: 'Pad 2'
                          api: null
                          cost_estimate: null
                          start_date: null
                          end_date: null
                          estimate_end_date: 12/31/2022
                          estimate_start_date: 12/16/2022
                          latitude: null
                          longitude: null
                          welldepth: null
                          note: null
                          internal_note: null
                          external_note: null
                          driving_direction: null
                          status: 0
                          service_area_id: 85
                          location_id: 757
                          created_at: '2022-12-16T20:29:34.000000Z'
                          updated_at: '2023-01-16T15:02:04.000000Z'
                          correlative_prefix: null
                          zero_quantity: 0
                          correlative: 4801
                          type: 0
                          is_managed: false
                          is_offline: false
                          drilling_contractor: null
                          rig_number: null
                          legal_description: null
                          tank_id: null
                          customer_id: 108
                          inputs:
                            '4':
                              'Location Pin': null
                            '6':
                              'SAP Ship To Account #': null
                            '7':
                              'Purchase Order': null
                          billing_location_id: 12
                          customer_type: 0
                          name: null
                          address: null
                          user_id: 142
                          external_id: null
                          computed_name: 'Unit 2040 Cascade Pad 2'
                          computed_formatted_correlative: '4801'
                          location:
                            id: 757
                            city: Kingfisher
                            zip_code: '73750'
                            state_id: 37
                            county_id: 2163
                            state:
                              id: 37
                              name: Oklahoma
                              code: OK
                            county:
                              id: 2163
                              name: Kingfisher
                              state_id: 37
                        -
                          id: 2425
                          job_state: null
                          spud_date: null
                          google_sheet_raw: null
                          operator: null
                          lease_name: 'MCR #CT-10637 CTB2 Carrizo Springs TX 78834'
                          well_number: USA
                          api: null
                          cost_estimate: null
                          start_date: null
                          end_date: null
                          estimate_end_date: 09/21/2025
                          estimate_start_date: 09/21/2022
                          latitude: null
                          longitude: null
                          welldepth: null
                          note: null
                          internal_note: null
                          external_note: null
                          driving_direction: null
                          status: 0
                          service_area_id: 88
                          location_id: 551
                          created_at: '2022-10-03T22:43:34.000000Z'
                          updated_at: '2023-01-16T20:26:34.000000Z'
                          correlative_prefix: null
                          zero_quantity: 0
                          correlative: 1724
                          type: 0
                          is_managed: true
                          is_offline: false
                          drilling_contractor: null
                          rig_number: null
                          legal_description: null
                          tank_id: null
                          customer_id: 162
                          inputs: []
                          billing_location_id: 66
                          customer_type: 0
                          name: null
                          address: null
                          user_id: null
                          external_id: null
                          computed_name: 'MCR #CT-10637 CTB2 Carrizo Springs TX 78834 USA'
                          computed_formatted_correlative: '1724'
                          location:
                            id: 551
                            city: null
                            zip_code: null
                            state_id: 44
                            county_id: 2582
                            state:
                              id: 44
                              name: Texas
                              code: TX
                            county:
                              id: 2582
                              name: Dimmit
                              state_id: 44
                      first_page_url: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      from: 1
                      last_page: 1
                      last_page_url: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      links:
                        -
                          url: null
                          label: '&laquo; Previous'
                          active: false
                        -
                          url: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                          label: '1'
                          active: true
                        -
                          url: null
                          label: 'Next &raquo;'
                          active: false
                      next_page_url: null
                      path: 'https://vendors.getlinkk.com/api/v1/jobs'
                      per_page: 10
                      prev_page_url: null
                      to: 2
                      total: 2
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        current_page: 1
                        data:
                          -
                            id: 5516
                            job_state: Production
                            spud_date: null
                            google_sheet_raw: null
                            operator: null
                            lease_name: 'Unit 2040 Cascade'
                            well_number: 'Pad 2'
                            api: null
                            cost_estimate: null
                            start_date: null
                            end_date: null
                            estimate_end_date: 12/31/2022
                            estimate_start_date: 12/16/2022
                            latitude: null
                            longitude: null
                            welldepth: null
                            note: null
                            internal_note: null
                            external_note: null
                            driving_direction: null
                            status: 0
                            service_area_id: 85
                            location_id: 757
                            created_at: '2022-12-16T20:29:34.000000Z'
                            updated_at: '2023-01-16T15:02:04.000000Z'
                            correlative_prefix: null
                            zero_quantity: 0
                            correlative: 4801
                            type: 0
                            is_managed: false
                            is_offline: false
                            drilling_contractor: null
                            rig_number: null
                            legal_description: null
                            tank_id: null
                            customer_id: 108
                            inputs:
                              4:
                                'Location Pin': null
                              6:
                                'SAP Ship To Account #': null
                              7:
                                'Purchase Order': null
                            billing_location_id: 12
                            customer_type: 0
                            name: null
                            address: null
                            user_id: 142
                            external_id: null
                            computed_name: 'Unit 2040 Cascade Pad 2'
                            computed_formatted_correlative: '4801'
                            location:
                              id: 757
                              city: Kingfisher
                              zip_code: '73750'
                              state_id: 37
                              county_id: 2163
                              state:
                                id: 37
                                name: Oklahoma
                                code: OK
                              county:
                                id: 2163
                                name: Kingfisher
                                state_id: 37
                          -
                            id: 2425
                            job_state: null
                            spud_date: null
                            google_sheet_raw: null
                            operator: null
                            lease_name: 'MCR #CT-10637 CTB2 Carrizo Springs TX 78834'
                            well_number: USA
                            api: null
                            cost_estimate: null
                            start_date: null
                            end_date: null
                            estimate_end_date: 09/21/2025
                            estimate_start_date: 09/21/2022
                            latitude: null
                            longitude: null
                            welldepth: null
                            note: null
                            internal_note: null
                            external_note: null
                            driving_direction: null
                            status: 0
                            service_area_id: 88
                            location_id: 551
                            created_at: '2022-10-03T22:43:34.000000Z'
                            updated_at: '2023-01-16T20:26:34.000000Z'
                            correlative_prefix: null
                            zero_quantity: 0
                            correlative: 1724
                            type: 0
                            is_managed: true
                            is_offline: false
                            drilling_contractor: null
                            rig_number: null
                            legal_description: null
                            tank_id: null
                            customer_id: 162
                            inputs: []
                            billing_location_id: 66
                            customer_type: 0
                            name: null
                            address: null
                            user_id: null
                            external_id: null
                            computed_name: 'MCR #CT-10637 CTB2 Carrizo Springs TX 78834 USA'
                            computed_formatted_correlative: '1724'
                            location:
                              id: 551
                              city: null
                              zip_code: null
                              state_id: 44
                              county_id: 2582
                              state:
                                id: 44
                                name: Texas
                                code: TX
                              county:
                                id: 2582
                                name: Dimmit
                                state_id: 44
                        first_page_url: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from: 1
                        last_page: 1
                        last_page_url: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        next_page_url: null
                        path: 'https://vendors.getlinkk.com/api/v1/jobs'
                        per_page: 10
                        prev_page_url: null
                        to: 2
                        total: 2
                    items:
                      type: object
                      properties:
                        current_page:
                          type: integer
                          example: 1
                        data:
                          type: array
                          example:
                            -
                              id: 5516
                              job_state: Production
                              spud_date: null
                              google_sheet_raw: null
                              operator: null
                              lease_name: 'Unit 2040 Cascade'
                              well_number: 'Pad 2'
                              api: null
                              cost_estimate: null
                              start_date: null
                              end_date: null
                              estimate_end_date: 12/31/2022
                              estimate_start_date: 12/16/2022
                              latitude: null
                              longitude: null
                              welldepth: null
                              note: null
                              internal_note: null
                              external_note: null
                              driving_direction: null
                              status: 0
                              service_area_id: 85
                              location_id: 757
                              created_at: '2022-12-16T20:29:34.000000Z'
                              updated_at: '2023-01-16T15:02:04.000000Z'
                              correlative_prefix: null
                              zero_quantity: 0
                              correlative: 4801
                              type: 0
                              is_managed: false
                              is_offline: false
                              drilling_contractor: null
                              rig_number: null
                              legal_description: null
                              tank_id: null
                              customer_id: 108
                              inputs:
                                4:
                                  'Location Pin': null
                                6:
                                  'SAP Ship To Account #': null
                                7:
                                  'Purchase Order': null
                              billing_location_id: 12
                              customer_type: 0
                              name: null
                              address: null
                              user_id: 142
                              external_id: null
                              computed_name: 'Unit 2040 Cascade Pad 2'
                              computed_formatted_correlative: '4801'
                              location:
                                id: 757
                                city: Kingfisher
                                zip_code: '73750'
                                state_id: 37
                                county_id: 2163
                                state:
                                  id: 37
                                  name: Oklahoma
                                  code: OK
                                county:
                                  id: 2163
                                  name: Kingfisher
                                  state_id: 37
                            -
                              id: 2425
                              job_state: null
                              spud_date: null
                              google_sheet_raw: null
                              operator: null
                              lease_name: 'MCR #CT-10637 CTB2 Carrizo Springs TX 78834'
                              well_number: USA
                              api: null
                              cost_estimate: null
                              start_date: null
                              end_date: null
                              estimate_end_date: 09/21/2025
                              estimate_start_date: 09/21/2022
                              latitude: null
                              longitude: null
                              welldepth: null
                              note: null
                              internal_note: null
                              external_note: null
                              driving_direction: null
                              status: 0
                              service_area_id: 88
                              location_id: 551
                              created_at: '2022-10-03T22:43:34.000000Z'
                              updated_at: '2023-01-16T20:26:34.000000Z'
                              correlative_prefix: null
                              zero_quantity: 0
                              correlative: 1724
                              type: 0
                              is_managed: true
                              is_offline: false
                              drilling_contractor: null
                              rig_number: null
                              legal_description: null
                              tank_id: null
                              customer_id: 162
                              inputs: []
                              billing_location_id: 66
                              customer_type: 0
                              name: null
                              address: null
                              user_id: null
                              external_id: null
                              computed_name: 'MCR #CT-10637 CTB2 Carrizo Springs TX 78834 USA'
                              computed_formatted_correlative: '1724'
                              location:
                                id: 551
                                city: null
                                zip_code: null
                                state_id: 44
                                county_id: 2582
                                state:
                                  id: 44
                                  name: Texas
                                  code: TX
                                county:
                                  id: 2582
                                  name: Dimmit
                                  state_id: 44
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 5516
                              job_state:
                                type: string
                                example: Production
                              spud_date:
                                type: string
                                example: null
                              google_sheet_raw:
                                type: string
                                example: null
                              operator:
                                type: string
                                example: null
                              lease_name:
                                type: string
                                example: 'Unit 2040 Cascade'
                              well_number:
                                type: string
                                example: 'Pad 2'
                              api:
                                type: string
                                example: null
                              cost_estimate:
                                type: string
                                example: null
                              start_date:
                                type: string
                                example: null
                              end_date:
                                type: string
                                example: null
                              estimate_end_date:
                                type: string
                                example: 12/31/2022
                              estimate_start_date:
                                type: string
                                example: 12/16/2022
                              latitude:
                                type: string
                                example: null
                              longitude:
                                type: string
                                example: null
                              welldepth:
                                type: string
                                example: null
                              note:
                                type: string
                                example: null
                              internal_note:
                                type: string
                                example: null
                              external_note:
                                type: string
                                example: null
                              driving_direction:
                                type: string
                                example: null
                              status:
                                type: integer
                                example: 0
                              service_area_id:
                                type: integer
                                example: 85
                              location_id:
                                type: integer
                                example: 757
                              created_at:
                                type: string
                                example: '2022-12-16T20:29:34.000000Z'
                              updated_at:
                                type: string
                                example: '2023-01-16T15:02:04.000000Z'
                              correlative_prefix:
                                type: string
                                example: null
                              zero_quantity:
                                type: integer
                                example: 0
                              correlative:
                                type: integer
                                example: 4801
                              type:
                                type: integer
                                example: 0
                              is_managed:
                                type: boolean
                                example: false
                              is_offline:
                                type: boolean
                                example: false
                              drilling_contractor:
                                type: string
                                example: null
                              rig_number:
                                type: string
                                example: null
                              legal_description:
                                type: string
                                example: null
                              tank_id:
                                type: string
                                example: null
                              customer_id:
                                type: integer
                                example: 108
                              inputs:
                                type: object
                                properties:
                                  4:
                                    type: object
                                    properties:
                                      'Location Pin': { type: string, example: null }
                                  6:
                                    type: object
                                    properties:
                                      'SAP Ship To Account #': { type: string, example: null }
                                  7:
                                    type: object
                                    properties:
                                      'Purchase Order': { type: string, example: null }
                              billing_location_id:
                                type: integer
                                example: 12
                              customer_type:
                                type: integer
                                example: 0
                              name:
                                type: string
                                example: null
                              address:
                                type: string
                                example: null
                              user_id:
                                type: integer
                                example: 142
                              external_id:
                                type: string
                                example: null
                              computed_name:
                                type: string
                                example: 'Unit 2040 Cascade Pad 2'
                              computed_formatted_correlative:
                                type: string
                                example: '4801'
                              location:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 757
                                  city:
                                    type: string
                                    example: Kingfisher
                                  zip_code:
                                    type: string
                                    example: '73750'
                                  state_id:
                                    type: integer
                                    example: 37
                                  county_id:
                                    type: integer
                                    example: 2163
                                  state:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 37 }
                                      name: { type: string, example: Oklahoma }
                                      code: { type: string, example: OK }
                                  county:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 2163 }
                                      name: { type: string, example: Kingfisher }
                                      state_id: { type: integer, example: 37 }
                        first_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from:
                          type: integer
                          example: 1
                        last_page:
                          type: integer
                          example: 1
                        last_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          type: array
                          example:
                            -
                              url: null
                              label: '&laquo; Previous'
                              active: false
                            -
                              url: 'https://vendors.getlinkk.com/api/v1/jobs?per_page=10&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                              label: '1'
                              active: true
                            -
                              url: null
                              label: 'Next &raquo;'
                              active: false
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              label:
                                type: string
                                example: '&laquo; Previous'
                              active:
                                type: boolean
                                example: false
                        next_page_url:
                          type: string
                          example: null
                        path:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/jobs'
                        per_page:
                          type: integer
                          example: 10
                        prev_page_url:
                          type: string
                          example: null
                        to:
                          type: integer
                          example: 2
                        total:
                          type: integer
                          example: 2
      tags:
        - Jobs
    post:
      summary: 'Job creation'
      operationId: jobCreation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Jobs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_type:
                  type: string
                  description: 'The type of customer to be created, 0 being a Lease Location customer and 1 being a Physical Address customer. Defaults to 0.'
                  example: '0'
                  enum:
                    - '0'
                    - '1'
                lease_name:
                  type: string
                  description: 'This field is required when <code>customer_type</code> is <code>0</code>. Must be at least 0 characters. Must not be greater than 200 characters.'
                  example: hmbklio
                api:
                  type: string
                  description: 'Must not be greater than 20 characters.'
                  example: jzcckbwvbkwapibmgtf
                cost_estimate:
                  type: number
                  description: ''
                  example: 0.822845
                zip_code:
                  type: string
                  description: 'This field is required when <code>customer_type</code> is <code>1</code>. Must be 5 characters.'
                  example: '12345'
                well_numbers:
                  type: object
                  description: 'The well numbers for the job. A different job will be created for each well number provided. Each well number must not exceed 100 characters. If updating, only the first value will be considered.'
                  example:
                    - 32H
                    - B4-4
                  properties: {  }
                welldepth:
                  type: string
                  description: 'Must be between 0 and 7 digits.'
                  example: '25430'
                field_emails:
                  type: string
                  description: ''
                  example: nihil
                internal_note:
                  type: string
                  description: 'Must be at least 0 characters. Must not be greater than 500 characters.'
                  example: rytlrcm
                external_note:
                  type: string
                  description: 'Must be at least 0 characters. Must not be greater than 500 characters.'
                  example: jnm
                driving_direction:
                  type: string
                  description: 'Must be at least 0 characters. Must not be greater than 1500 characters.'
                  example: niutjjxoaludbrrzxe
                estimate_start_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                estimate_end_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                start_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                end_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                legal_description:
                  type: string
                  description: 'Must not be greater than 255 characters.'
                  example: wavwcgonpiswjaxdhsr
                is_managed:
                  type: string
                  description: 'Determines if the job is managed or not. Defaults to 0.'
                  example: '0'
                  enum:
                    - '0'
                    - '1'
                tank_id:
                  type: string
                  description: 'This field is required when <code>is_managed</code> is <code>1</code>.'
                  example: null
                address:
                  type: string
                  description: 'This field is required when <code>customer_type</code> is <code>1</code>.'
                  example: '4306 Hott Street'
                service_area_id:
                  type: integer
                  description: ''
                  example: 5
                city:
                  type: string
                  description: 'This field is required when <code>customer_type</code> is <code>1</code>.  Must match the regex /(^[A-Za-z ]+$)+/.'
                  example: 'Oklahoma City'
                state:
                  type: string
                  description: ''
                  example: Oklahoma
                county:
                  type: string
                  description: ''
                  example: Oklahoma
                customer_id:
                  type: string
                  description: 'The customer that the job will belong to. Provide any of the following values to identify the customer: id, FEIN, vendor_number.'
                  example: '123456789'
                billing_location_id:
                  type: string
                  description: 'The billing location that the job will belong to. Provide any of the following values to identify the billing location to be updated: id, billing_account.'
                  example: sed
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: zumvhiyeieta
                custom_fields:
                  type: object
                  description: 'Custom fields that may or may not be required for job creation and edition. See /jobs/custom-fields endpoint to retrieve a list of available custom fields. Format is id => value.'
                  example:
                    1: 'Custom field value'
                  properties: {  }
              required:
                - customer_id
                - billing_location_id
  '/api/v1/jobs/{identifier}':
    get:
      summary: 'Retrieve a specific job'
      operationId: retrieveASpecificJob
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      id: 5115
                      job_state: Production
                      spud_date: null
                      google_sheet_raw: null
                      operator: null
                      lease_name: 'Unit 2116 Wolf CS'
                      well_number: '#3'
                      api: null
                      cost_estimate: null
                      start_date: null
                      end_date: null
                      estimate_end_date: 10/29/2022
                      estimate_start_date: 10/12/2022
                      latitude: 32
                      longitude: -101
                      welldepth: null
                      note: null
                      internal_note: null
                      external_note: null
                      driving_direction: null
                      status: 0
                      service_area_id: 82
                      location_id: 612
                      created_at: '2022-10-12T16:29:57.000000Z'
                      updated_at: '2023-05-03T09:42:05.000000Z'
                      correlative_prefix: null
                      zero_quantity: 0
                      correlative: 4409
                      type: 0
                      is_managed: false
                      is_offline: false
                      drilling_contractor: null
                      rig_number: null
                      legal_description: null
                      tank_id: null
                      customer_id: 108
                      inputs:
                        '4': null
                        '6':
                          'SAP Ship To Account #': '117363'
                        '7': null
                      billing_location_id: 12
                      customer_type: 0
                      name: null
                      address: null
                      user_id: null
                      external_id: null
                      computed_name: 'Unit 2116 Wolf CS #3'
                      computed_formatted_correlative: '4409'
                      location:
                        id: 612
                        city: null
                        zip_code: null
                        state_id: 44
                        county_id: 2632
                        state:
                          id: 44
                          name: Texas
                          code: TX
                        county:
                          id: 2632
                          name: Howard
                          state_id: 44
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        id: 5115
                        job_state: Production
                        spud_date: null
                        google_sheet_raw: null
                        operator: null
                        lease_name: 'Unit 2116 Wolf CS'
                        well_number: '#3'
                        api: null
                        cost_estimate: null
                        start_date: null
                        end_date: null
                        estimate_end_date: 10/29/2022
                        estimate_start_date: 10/12/2022
                        latitude: 32
                        longitude: -101
                        welldepth: null
                        note: null
                        internal_note: null
                        external_note: null
                        driving_direction: null
                        status: 0
                        service_area_id: 82
                        location_id: 612
                        created_at: '2022-10-12T16:29:57.000000Z'
                        updated_at: '2023-05-03T09:42:05.000000Z'
                        correlative_prefix: null
                        zero_quantity: 0
                        correlative: 4409
                        type: 0
                        is_managed: false
                        is_offline: false
                        drilling_contractor: null
                        rig_number: null
                        legal_description: null
                        tank_id: null
                        customer_id: 108
                        inputs:
                          4: null
                          6:
                            'SAP Ship To Account #': '117363'
                          7: null
                        billing_location_id: 12
                        customer_type: 0
                        name: null
                        address: null
                        user_id: null
                        external_id: null
                        computed_name: 'Unit 2116 Wolf CS #3'
                        computed_formatted_correlative: '4409'
                        location:
                          id: 612
                          city: null
                          zip_code: null
                          state_id: 44
                          county_id: 2632
                          state:
                            id: 44
                            name: Texas
                            code: TX
                          county:
                            id: 2632
                            name: Howard
                            state_id: 44
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 5115
                        job_state:
                          type: string
                          example: Production
                        spud_date:
                          type: string
                          example: null
                        google_sheet_raw:
                          type: string
                          example: null
                        operator:
                          type: string
                          example: null
                        lease_name:
                          type: string
                          example: 'Unit 2116 Wolf CS'
                        well_number:
                          type: string
                          example: '#3'
                        api:
                          type: string
                          example: null
                        cost_estimate:
                          type: string
                          example: null
                        start_date:
                          type: string
                          example: null
                        end_date:
                          type: string
                          example: null
                        estimate_end_date:
                          type: string
                          example: 10/29/2022
                        estimate_start_date:
                          type: string
                          example: 10/12/2022
                        latitude:
                          type: integer
                          example: 32
                        longitude:
                          type: integer
                          example: -101
                        welldepth:
                          type: string
                          example: null
                        note:
                          type: string
                          example: null
                        internal_note:
                          type: string
                          example: null
                        external_note:
                          type: string
                          example: null
                        driving_direction:
                          type: string
                          example: null
                        status:
                          type: integer
                          example: 0
                        service_area_id:
                          type: integer
                          example: 82
                        location_id:
                          type: integer
                          example: 612
                        created_at:
                          type: string
                          example: '2022-10-12T16:29:57.000000Z'
                        updated_at:
                          type: string
                          example: '2023-05-03T09:42:05.000000Z'
                        correlative_prefix:
                          type: string
                          example: null
                        zero_quantity:
                          type: integer
                          example: 0
                        correlative:
                          type: integer
                          example: 4409
                        type:
                          type: integer
                          example: 0
                        is_managed:
                          type: boolean
                          example: false
                        is_offline:
                          type: boolean
                          example: false
                        drilling_contractor:
                          type: string
                          example: null
                        rig_number:
                          type: string
                          example: null
                        legal_description:
                          type: string
                          example: null
                        tank_id:
                          type: string
                          example: null
                        customer_id:
                          type: integer
                          example: 108
                        inputs:
                          type: object
                          properties:
                            4:
                              type: string
                              example: null
                            6:
                              type: object
                              properties:
                                'SAP Ship To Account #':
                                  type: string
                                  example: '117363'
                            7:
                              type: string
                              example: null
                        billing_location_id:
                          type: integer
                          example: 12
                        customer_type:
                          type: integer
                          example: 0
                        name:
                          type: string
                          example: null
                        address:
                          type: string
                          example: null
                        user_id:
                          type: string
                          example: null
                        external_id:
                          type: string
                          example: null
                        computed_name:
                          type: string
                          example: 'Unit 2116 Wolf CS #3'
                        computed_formatted_correlative:
                          type: string
                          example: '4409'
                        location:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 612
                            city:
                              type: string
                              example: null
                            zip_code:
                              type: string
                              example: null
                            state_id:
                              type: integer
                              example: 44
                            county_id:
                              type: integer
                              example: 2632
                            state:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 44
                                name:
                                  type: string
                                  example: Texas
                                code:
                                  type: string
                                  example: TX
                            county:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2632
                                name:
                                  type: string
                                  example: Howard
                                state_id:
                                  type: integer
                                  example: 44
      tags:
        - Jobs
    patch:
      summary: 'Job update'
      operationId: jobUpdate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Jobs
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_type:
                  type: string
                  description: 'The type of customer to be created, 0 being a Lease Location customer and 1 being a Physical Address customer. Defaults to 0.'
                  example: '0'
                  enum:
                    - '0'
                    - '1'
                lease_name:
                  type: string
                  description: 'This field is required when <code>customer_type</code> is <code>0</code>. Must be at least 0 characters. Must not be greater than 200 characters.'
                  example: fnhaebgtovgakzlvpbab
                api:
                  type: string
                  description: 'Must not be greater than 20 characters.'
                  example: hofsvmlzovvrvxwo
                cost_estimate:
                  type: number
                  description: ''
                  example: 57.0
                zip_code:
                  type: string
                  description: 'This field is required when <code>customer_type</code> is <code>1</code>. Must be 5 characters.'
                  example: '12345'
                well_numbers:
                  type: object
                  description: 'The well numbers for the job. A different job will be created for each well number provided. Each well number must not exceed 100 characters. If updating, only the first value will be considered. This field is required when <code>customer_type</code> is <code>0</code>.'
                  example:
                    - 32H
                    - B4-4
                  properties: {  }
                welldepth:
                  type: string
                  description: 'Must be between 0 and 7 digits.'
                  example: '0'
                field_emails:
                  type: string
                  description: ''
                  example: laborum
                internal_note:
                  type: string
                  description: 'Must be at least 0 characters. Must not be greater than 500 characters.'
                  example: exf
                external_note:
                  type: string
                  description: 'Must be at least 0 characters. Must not be greater than 500 characters.'
                  example: wpnoewenebonnplmrqnrzppl
                driving_direction:
                  type: string
                  description: 'Must be at least 0 characters. Must not be greater than 1500 characters.'
                  example: oyimg
                estimate_start_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                estimate_end_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                start_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                end_date:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                legal_description:
                  type: string
                  description: 'Must not be greater than 255 characters.'
                  example: fjvzkrlheomo
                is_managed:
                  type: string
                  description: 'Determines if the job is managed or not. Defaults to 0.'
                  example: '0'
                  enum:
                    - '0'
                    - '1'
                tank_id:
                  type: string
                  description: 'This field is required when <code>is_managed</code> is <code>1</code>.'
                  example: null
                address:
                  type: string
                  description: 'This field is required when <code>customer_type</code> is <code>1</code>. Must be at least 6 characters.'
                  example: '4306 Hott Street'
                service_area_id:
                  type: integer
                  description: ''
                  example: 9
                city:
                  type: string
                  description: 'This field is required when <code>customer_type</code> is <code>1</code>.  Must match the regex /(^[A-Za-z ]+$)+/. Must be at least 3 characters.'
                  example: 'Oklahoma City'
                state:
                  type: string
                  description: ''
                  example: Oklahoma
                county:
                  type: string
                  description: ''
                  example: Oklahoma
                customer_id:
                  type: integer
                  description: 'The customer that the job will belong to. Provide any of the following values to identify the customer: id, FEIN, vendor_number.'
                  example: 123456789
    parameters:
      -
        in: path
        name: identifier
        description: ''
        example: 5115
        required: true
        schema:
          type: integer
  '/api/v1/jobs/{identifier}/archive':
    patch:
      summary: 'Job archive'
      operationId: jobArchive
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Jobs
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the job to be archived: correlative.'
        example: magnam
        required: true
        schema:
          type: string
  '/api/v1/jobs/{identifier}/activate':
    patch:
      summary: 'Job activate'
      operationId: jobActivate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Jobs
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the job to be (re)activated: correlative.'
        example: nesciunt
        required: true
        schema:
          type: string
  /api/v1/material-groups:
    get:
      summary: 'Retrieve main list of material groups'
      operationId: retrieveMainListOfMaterialGroups
      description: ''
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of elements per page. Defaults to 15.'
          example: 11
          required: false
          schema:
            type: integer
            description: 'Number of elements per page. Defaults to 15.'
            example: 11
        -
          in: query
          name: before
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-23 12:00:00'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-23 12:00:00'
        -
          in: query
          name: after
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-01'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      current_page: 1
                      data: []
                      first_page_url: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      from: null
                      last_page: 1
                      last_page_url: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      links:
                        -
                          url: null
                          label: '&laquo; Previous'
                          active: false
                        -
                          url: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                          label: '1'
                          active: true
                        -
                          url: null
                          label: 'Next &raquo;'
                          active: false
                      next_page_url: null
                      path: 'https://vendors.getlinkk.com/api/v1/material-groups'
                      per_page: 11
                      prev_page_url: null
                      to: null
                      total: 0
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        current_page: 1
                        data: []
                        first_page_url: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from: null
                        last_page: 1
                        last_page_url: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        next_page_url: null
                        path: 'https://vendors.getlinkk.com/api/v1/material-groups'
                        per_page: 11
                        prev_page_url: null
                        to: null
                        total: 0
                    items:
                      type: object
                      properties:
                        current_page:
                          type: integer
                          example: 1
                        data:
                          type: array
                          example: []
                        first_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from:
                          type: string
                          example: null
                        last_page:
                          type: integer
                          example: 1
                        last_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          type: array
                          example:
                            -
                              url: null
                              label: '&laquo; Previous'
                              active: false
                            -
                              url: 'https://vendors.getlinkk.com/api/v1/material-groups?per_page=11&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                              label: '1'
                              active: true
                            -
                              url: null
                              label: 'Next &raquo;'
                              active: false
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              label:
                                type: string
                                example: '&laquo; Previous'
                              active:
                                type: boolean
                                example: false
                        next_page_url:
                          type: string
                          example: null
                        path:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/material-groups'
                        per_page:
                          type: integer
                          example: 11
                        prev_page_url:
                          type: string
                          example: null
                        to:
                          type: string
                          example: null
                        total:
                          type: integer
                          example: 0
      tags:
        - 'Material Groups'
    post:
      summary: 'Material group creation'
      operationId: materialGroupCreation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Material Groups'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 50 characters.'
                  example: cljmnsjgnpqty
                description:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: 'A facere enim voluptate explicabo facilis voluptatem.'
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: whcwgdz
              required:
                - name
                - description
  '/api/v1/material-groups/{identifier}':
    get:
      summary: 'Retrieve a specific material group'
      operationId: retrieveASpecificMaterialGroup
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  message: 'Material group not found'
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Material group not found'
      tags:
        - 'Material Groups'
    patch:
      summary: 'Material group update'
      operationId: materialGroupUpdate
      description: 'Active status changes will be ignored. Please use the archive and activate endpoints for that purpose.'
      parameters: []
      responses: {  }
      tags:
        - 'Material Groups'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 50 characters.'
                  example: nllbzujmiywnqegbwzr
                description:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: 'Possimus itaque suscipit molestiae qui quia et rerum.'
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: vnienvc
              required:
                - name
                - description
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the material group: id, external_id.'
        example: amet
        required: true
        schema:
          type: string
  '/api/v1/material-groups/{identifier}/archive':
    patch:
      summary: 'Material group archive'
      operationId: materialGroupArchive
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Material Groups'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the material group to be archived: id, external_id.'
        example: corporis
        required: true
        schema:
          type: string
  '/api/v1/material-groups/{identifier}/activate':
    patch:
      summary: 'Material group activate'
      operationId: materialGroupActivate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Material Groups'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the material group to be (re)activated: id, external_id.'
        example: et
        required: true
        schema:
          type: string
  /api/v1/materials:
    get:
      summary: 'Retrieve main list of materials'
      operationId: retrieveMainListOfMaterials
      description: ''
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of elements per page. Defaults to 15.'
          example: 14
          required: false
          schema:
            type: integer
            description: 'Number of elements per page. Defaults to 15.'
            example: 14
        -
          in: query
          name: before
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-23 12:00:00'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-23 12:00:00'
        -
          in: query
          name: after
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-01'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      current_page: 1
                      data: []
                      first_page_url: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      from: null
                      last_page: 1
                      last_page_url: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      links:
                        -
                          url: null
                          label: '&laquo; Previous'
                          active: false
                        -
                          url: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                          label: '1'
                          active: true
                        -
                          url: null
                          label: 'Next &raquo;'
                          active: false
                      next_page_url: null
                      path: 'https://vendors.getlinkk.com/api/v1/materials'
                      per_page: 14
                      prev_page_url: null
                      to: null
                      total: 0
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        current_page: 1
                        data: []
                        first_page_url: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from: null
                        last_page: 1
                        last_page_url: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        next_page_url: null
                        path: 'https://vendors.getlinkk.com/api/v1/materials'
                        per_page: 14
                        prev_page_url: null
                        to: null
                        total: 0
                    items:
                      type: object
                      properties:
                        current_page:
                          type: integer
                          example: 1
                        data:
                          type: array
                          example: []
                        first_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from:
                          type: string
                          example: null
                        last_page:
                          type: integer
                          example: 1
                        last_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          type: array
                          example:
                            -
                              url: null
                              label: '&laquo; Previous'
                              active: false
                            -
                              url: 'https://vendors.getlinkk.com/api/v1/materials?per_page=14&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                              label: '1'
                              active: true
                            -
                              url: null
                              label: 'Next &raquo;'
                              active: false
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              label:
                                type: string
                                example: '&laquo; Previous'
                              active:
                                type: boolean
                                example: false
                        next_page_url:
                          type: string
                          example: null
                        path:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/materials'
                        per_page:
                          type: integer
                          example: 14
                        prev_page_url:
                          type: string
                          example: null
                        to:
                          type: string
                          example: null
                        total:
                          type: integer
                          example: 0
      tags:
        - Materials
    post:
      summary: 'Material creation'
      operationId: materialCreation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Materials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: yrqdjvhqtompxoann
                description:
                  type: string
                  description: 'Must not be greater than 250 characters.'
                  example: 'Iste enim dolores voluptatibus.'
                number:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: xykdieywj
                measurement_unit_id:
                  type: string
                  description: ''
                  example: velit
                service_types:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                material_group_id:
                  type: string
                  description: 'The material group that the material will belong to. Provide any of the following values to identify the material group: id, external_id.'
                  example: ipsa
                manufacturer:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: fbnsxe
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: zhyfwmpdgkygia
              required:
                - name
                - description
                - number
                - measurement_unit_id
                - material_group_id
  '/api/v1/materials/{identifier}':
    get:
      summary: 'Retrieve a specific material'
      operationId: retrieveASpecificMaterial
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  message: 'Material not found'
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Material not found'
      tags:
        - Materials
    patch:
      summary: 'Material update'
      operationId: materialUpdate
      description: 'Active status changes will be ignored. Please use the archive and activate endpoints for that purpose.'
      parameters: []
      responses: {  }
      tags:
        - Materials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: vmf
                description:
                  type: string
                  description: 'Must not be greater than 250 characters.'
                  example: 'Voluptatem et rerum quasi qui id et quia.'
                number:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: ndbgbacf
                measurement_unit_id:
                  type: string
                  description: ''
                  example: cupiditate
                service_types:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                material_group_id:
                  type: string
                  description: 'The material group that the material will belong to. Provide any of the following values to identify the material group: id, external_id.'
                  example: dolor
                manufacturer:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: aljfaqpcydgt
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: knjsqqjtdmitjthscybur
              required:
                - name
                - description
                - number
                - measurement_unit_id
                - material_group_id
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the material: id, number.'
        example: consequuntur
        required: true
        schema:
          type: string
  '/api/v1/materials/{identifier}/archive':
    patch:
      summary: 'Material archive'
      operationId: materialArchive
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Materials
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the material to be archived: id, number.'
        example: non
        required: true
        schema:
          type: string
  '/api/v1/materials/{identifier}/activate':
    patch:
      summary: 'Material activate'
      operationId: materialActivate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Materials
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the material to be (re)activated: id, number.'
        example: libero
        required: true
        schema:
          type: string
  /api/v1/test:
    get:
      summary: 'Authentication test'
      operationId: authenticationTest
      description: 'This is a temporary endpoint to verify authentication.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: Authenticated
                  body: []
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Authenticated
                  body:
                    type: array
                    example: []
      tags:
        - Miscellaneous
  /api/v1/orders:
    get:
      summary: 'Retrieve main list of orders'
      operationId: retrieveMainListOfOrders
      description: 'Provide the following values for the job_id field to identify and filter by job: id.'
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of elements per page. Defaults to 15.'
          example: 16
          required: false
          schema:
            type: integer
            description: 'Number of elements per page. Defaults to 15.'
            example: 16
        -
          in: query
          name: before
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-23 12:00:00'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-23 12:00:00'
        -
          in: query
          name: after
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-01'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      current_page: 1
                      data: []
                      first_page_url: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                      from: null
                      last_page: 1
                      last_page_url: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                      links:
                        -
                          url: null
                          label: '&laquo; Previous'
                          active: false
                        -
                          url: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                          label: '1'
                          active: true
                        -
                          url: null
                          label: 'Next &raquo;'
                          active: false
                      next_page_url: null
                      path: 'https://vendors.getlinkk.com/api/v1/orders'
                      per_page: 16
                      prev_page_url: null
                      to: null
                      total: 0
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        current_page: 1
                        data: []
                        first_page_url: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                        from: null
                        last_page: 1
                        last_page_url: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                        links:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        next_page_url: null
                        path: 'https://vendors.getlinkk.com/api/v1/orders'
                        per_page: 16
                        prev_page_url: null
                        to: null
                        total: 0
                    items:
                      type: object
                      properties:
                        current_page:
                          type: integer
                          example: 1
                        data:
                          type: array
                          example: []
                        first_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                        from:
                          type: string
                          example: null
                        last_page:
                          type: integer
                          example: 1
                        last_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                        links:
                          type: array
                          example:
                            -
                              url: null
                              label: '&laquo; Previous'
                              active: false
                            -
                              url: 'https://vendors.getlinkk.com/api/v1/orders?page=1'
                              label: '1'
                              active: true
                            -
                              url: null
                              label: 'Next &raquo;'
                              active: false
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              label:
                                type: string
                                example: '&laquo; Previous'
                              active:
                                type: boolean
                                example: false
                        next_page_url:
                          type: string
                          example: null
                        path:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/orders'
                        per_page:
                          type: integer
                          example: 16
                        prev_page_url:
                          type: string
                          example: null
                        to:
                          type: string
                          example: null
                        total:
                          type: integer
                          example: 0
      tags:
        - Orders
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                job_id:
                  type: string
                  description: ''
                  example: iste
                active_status:
                  type: string
                  description: 'The active status of the order. 0 will return only archived orders, 1 only active ones. If this filter is not provided.'
                  example: '1'
                  enum:
                    - '0'
                    - '1'
    post:
      summary: 'Order creation'
      operationId: orderCreation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Orders
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                job_id:
                  type: string
                  description: 'The job that the order will belong to. Provide the following value to identify the job: id, correlative.'
                  example: '1'
                date_requested:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                start_time:
                  type: string
                  description: 'Must be a valid date in the format <code>H:i</code>.'
                  example: '11:00'
                end_time:
                  type: string
                  description: 'Must be a valid date in the format <code>H:i</code>.'
                  example: '13:00'
                internal_note:
                  type: string
                  description: 'Must be at least 6 characters. Must not be greater than 500 characters.'
                  example: orhxsfpfhn
                external_note:
                  type: string
                  description: 'Must be at least 6 characters. Must not be greater than 500 characters.'
                  example: qbrmp
                job_driving_directions:
                  type: string
                  description: 'Must be at least 6 characters. Must not be greater than 1500 characters.'
                  example: wp
                service_type_id:
                  type: integer
                  description: ''
                  example: 14
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: txtsbmviyqktqfwbtkkeo
                external_invoice_id:
                  type: string
                  description: ''
                  example: null
                external_doc_type:
                  type: string
                  description: ''
                  example: repudiandae
                external_delivery_id:
                  type: string
                  description: ''
                  example: ut
                materials:
                  type: array
                  description: ''
                  example:
                    - []
                  items:
                    type: object
                    properties:
                      material_id:
                        type: integer
                        description: 'Identifier of one of the material. Provide any of the following values as an identifier: id, number.'
                        example: 1
                      external_id:
                        type: string
                        description: ''
                        example: null
                      quantity_requested:
                        type: integer
                        description: ''
                        example: 15
                      tax_percent:
                        type: number
                        description: 'Must be at least 0.'
                        example: 4.35
                      tax_amount:
                        type: number
                        description: ''
                        example: 4.35
                      subtotal:
                        type: number
                        description: 'Must be at least 0.'
                        example: 104.35
                      is_extraction:
                        type: boolean
                        description: ''
                        example: true
                      taxes:
                        type: array
                        description: ''
                        example: null
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              description: ''
                              example: TX
                            rate:
                              type: number
                              description: 'Must be at least 0.'
                              example: 6.25
                            amount:
                              type: number
                              description: ''
                              example: 4.5
                    required:
                      - material_id
                      - quantity_requested
                is_extraction:
                  type: boolean
                  description: ''
                  example: false
              required:
                - job_id
                - date_requested
                - materials
  '/api/v1/orders/{identifier}':
    get:
      summary: 'Retrieve a specific order'
      operationId: retrieveASpecificOrder
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  message: 'Order not found'
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Order not found'
      tags:
        - Orders
    patch:
      summary: 'Order update'
      operationId: orderUpdate
      description: 'Active status changes will be ignored. Please use the archive and activate endpoints for that purpose.'
      parameters: []
      responses: {  }
      tags:
        - Orders
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                date_requested:
                  type: string
                  description: 'Must be a valid date in the format <code>m/d/Y</code>.'
                  example: 11/13/2025
                start_time:
                  type: string
                  description: 'Must be a valid date in the format <code>H:i</code>.'
                  example: '11:00'
                end_time:
                  type: string
                  description: 'Must be a valid date in the format <code>H:i</code>.'
                  example: '13:00'
                internal_note:
                  type: string
                  description: 'Must be at least 6 characters. Must not be greater than 500 characters.'
                  example: piqaeyftqzhdnghcyweqfc
                external_note:
                  type: string
                  description: 'Must be at least 6 characters. Must not be greater than 500 characters.'
                  example: hvbzclumvddjzsnyydxx
                job_driving_directions:
                  type: string
                  description: 'Must be at least 6 characters. Must not be greater than 1500 characters.'
                  example: fgefxpilc
                service_type_id:
                  type: integer
                  description: ''
                  example: 12
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: lpyew
                external_invoice_id:
                  type: string
                  description: ''
                  example: null
                external_doc_type:
                  type: string
                  description: ''
                  example: eveniet
                external_delivery_id:
                  type: string
                  description: ''
                  example: voluptas
                materials:
                  type: array
                  description: ''
                  example: null
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        description: ''
                        example: null
                      material_id:
                        type: integer
                        description: 'Identifier of one of the material. Provide any of the following values as an identifier: id, number.'
                        example: 1
                      external_id:
                        type: string
                        description: ''
                        example: null
                      quantity_requested:
                        type: integer
                        description: ''
                        example: 8
                      unit_price:
                        type: number
                        description: 'Must be at least 0.'
                        example: 27
                      tax_percent:
                        type: number
                        description: 'Must be at least 0.'
                        example: 4.35
                      tax_amount:
                        type: number
                        description: ''
                        example: 4.35
                      subtotal:
                        type: number
                        description: ''
                        example: 104.35
                      is_extraction:
                        type: boolean
                        description: ''
                        example: true
                      taxes:
                        type: array
                        description: ''
                        example: null
                        items:
                          type: object
                          properties:
                            order_material_id:
                              type: integer
                              description: ''
                              example: 6
                            code:
                              type: string
                              description: ''
                              example: 'Fuel Taxes:OK-ENV-DSL'
                            description:
                              type: string
                              description: ''
                              example: 'Oklahoma State Environmental Fee UST'
                            rate:
                              type: number
                              description: 'Must be at least 0.'
                              example: 6.25
                            amount:
                              type: number
                              description: ''
                              example: 4.5
                      delete:
                        type: boolean
                        description: ''
                        example: false
                is_extraction:
                  type: boolean
                  description: ''
                  example: false
                credit_hold:
                  type: boolean
                  description: ''
                  example: false
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the order: id, external_id.'
        example: vel
        required: true
        schema:
          type: string
  '/api/v1/orders/{identifier}/pdf':
    get:
      summary: ''
      operationId: getApiV1OrdersIdentifierPdf
      description: ''
      parameters: []
      responses:
        500:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Server Error'
                properties:
                  message:
                    type: string
                    example: 'Server Error'
      tags:
        - Orders
    parameters:
      -
        in: path
        name: identifier
        description: ''
        example: 1
        required: true
        schema:
          type: integer
  '/api/v1/orders/{identifier}/archive':
    patch:
      summary: 'Order archive'
      operationId: orderArchive
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Orders
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the order to be archived: id, external_id.'
        example: ullam
        required: true
        schema:
          type: string
  '/api/v1/orders/{identifier}/activate':
    patch:
      summary: 'Order activate'
      operationId: orderActivate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Orders
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the order to be (re)activated: id, external_id.'
        example: voluptas
        required: true
        schema:
          type: string
  /api/v1/service-areas:
    get:
      summary: 'Retrieve main list of service areas'
      operationId: retrieveMainListOfServiceAreas
      description: ''
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of elements per page. Defaults to 15.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'Number of elements per page. Defaults to 15.'
            example: 20
        -
          in: query
          name: before
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-23 12:00:00'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-23 12:00:00'
        -
          in: query
          name: after
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-01'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      current_page: 1
                      data:
                        -
                          id: 85
                          name: 'El Reno'
                          description: 'El Reno'
                          status: 1
                          company_id: 32
                          created_at: '2022-10-03T22:41:29.000000Z'
                          updated_at: '2023-01-12T03:05:30.000000Z'
                          external_id: null
                      first_page_url: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      from: 1
                      last_page: 1
                      last_page_url: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      links:
                        -
                          url: null
                          label: '&laquo; Previous'
                          active: false
                        -
                          url: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                          label: '1'
                          active: true
                        -
                          url: null
                          label: 'Next &raquo;'
                          active: false
                      next_page_url: null
                      path: 'https://vendors.getlinkk.com/api/v1/service-areas'
                      per_page: 20
                      prev_page_url: null
                      to: 1
                      total: 1
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        current_page: 1
                        data:
                          -
                            id: 85
                            name: 'El Reno'
                            description: 'El Reno'
                            status: 1
                            company_id: 32
                            created_at: '2022-10-03T22:41:29.000000Z'
                            updated_at: '2023-01-12T03:05:30.000000Z'
                            external_id: null
                        first_page_url: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from: 1
                        last_page: 1
                        last_page_url: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        next_page_url: null
                        path: 'https://vendors.getlinkk.com/api/v1/service-areas'
                        per_page: 20
                        prev_page_url: null
                        to: 1
                        total: 1
                    items:
                      type: object
                      properties:
                        current_page:
                          type: integer
                          example: 1
                        data:
                          type: array
                          example:
                            -
                              id: 85
                              name: 'El Reno'
                              description: 'El Reno'
                              status: 1
                              company_id: 32
                              created_at: '2022-10-03T22:41:29.000000Z'
                              updated_at: '2023-01-12T03:05:30.000000Z'
                              external_id: null
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 85
                              name:
                                type: string
                                example: 'El Reno'
                              description:
                                type: string
                                example: 'El Reno'
                              status:
                                type: integer
                                example: 1
                              company_id:
                                type: integer
                                example: 32
                              created_at:
                                type: string
                                example: '2022-10-03T22:41:29.000000Z'
                              updated_at:
                                type: string
                                example: '2023-01-12T03:05:30.000000Z'
                              external_id:
                                type: string
                                example: null
                        first_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from:
                          type: integer
                          example: 1
                        last_page:
                          type: integer
                          example: 1
                        last_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          type: array
                          example:
                            -
                              url: null
                              label: '&laquo; Previous'
                              active: false
                            -
                              url: 'https://vendors.getlinkk.com/api/v1/service-areas?per_page=20&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                              label: '1'
                              active: true
                            -
                              url: null
                              label: 'Next &raquo;'
                              active: false
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              label:
                                type: string
                                example: '&laquo; Previous'
                              active:
                                type: boolean
                                example: false
                        next_page_url:
                          type: string
                          example: null
                        path:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/service-areas'
                        per_page:
                          type: integer
                          example: 20
                        prev_page_url:
                          type: string
                          example: null
                        to:
                          type: integer
                          example: 1
                        total:
                          type: integer
                          example: 1
      tags:
        - 'Service Areas'
    post:
      summary: 'Service area creation'
      operationId: serviceAreaCreation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Service Areas'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 50 characters.'
                  example: rgrx
                description:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: 'Deserunt suscipit pariatur eligendi maxime.'
                locations:
                  type: array
                  description: 'Must have at least 1 items.'
                  example:
                    - []
                  items:
                    type: object
                    properties:
                      state:
                        type: string
                        description: ''
                        example: Oklahoma
                      county:
                        type: string
                        description: ''
                        example: Oklahoma
                      zip_code:
                        type: string
                        description: 'Must match the regex /^[0-9]{0,5}$/. Must be 5 characters.'
                        example: '12345'
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: oagyfutczyhrfwo
              required:
                - name
                - description
                - locations
  '/api/v1/service-areas/{identifier}':
    get:
      summary: 'Retrieve a specific service area'
      operationId: retrieveASpecificServiceArea
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  message: 'Service area not found'
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Service area not found'
      tags:
        - 'Service Areas'
    patch:
      summary: 'Service area update'
      operationId: serviceAreaUpdate
      description: 'Active status changes will be ignored. Please use the archive and activate endpoints for that purpose.'
      parameters: []
      responses: {  }
      tags:
        - 'Service Areas'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 50 characters.'
                  example: lzpuhrqlvqmsvhh
                description:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: 'Sunt adipisci voluptatum ut ea quam excepturi quibusdam.'
                locations:
                  type: array
                  description: 'Must have at least 1 items.'
                  example:
                    - []
                  items:
                    type: object
                    properties:
                      state:
                        type: string
                        description: ''
                        example: Oklahoma
                      county:
                        type: string
                        description: ''
                        example: Oklahoma
                      zip_code:
                        type: string
                        description: 'Must match the regex /^[0-9]{0,5}$/. Must be 5 characters.'
                        example: '12345'
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: dzufycgddjrdwkjrmz
              required:
                - name
                - description
                - locations
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the service area: id, external_id.'
        example: dignissimos
        required: true
        schema:
          type: string
  '/api/v1/service-areas/{identifier}/archive':
    patch:
      summary: 'Service area archive'
      operationId: serviceAreaArchive
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Service Areas'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the service area to be archived: id, external_id.'
        example: nobis
        required: true
        schema:
          type: string
  '/api/v1/service-areas/{identifier}/activate':
    patch:
      summary: 'Service area activate'
      operationId: serviceAreaActivate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Service Areas'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the service area to be (re)activated: id, external_id.'
        example: ut
        required: true
        schema:
          type: string
  /api/v1/service-types:
    get:
      summary: 'Retrieve main list of service types'
      operationId: retrieveMainListOfServiceTypes
      description: ''
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of elements per page. Defaults to 15.'
          example: 5
          required: false
          schema:
            type: integer
            description: 'Number of elements per page. Defaults to 15.'
            example: 5
        -
          in: query
          name: before
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-23 12:00:00'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-23 12:00:00'
        -
          in: query
          name: after
          description: 'Filter by updated date (UTC time).'
          example: '2023-01-01'
          required: false
          schema:
            type: string
            description: 'Filter by updated date (UTC time).'
            example: '2023-01-01'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      current_page: 1
                      data: []
                      first_page_url: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      from: null
                      last_page: 1
                      last_page_url: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                      links:
                        -
                          url: null
                          label: '&laquo; Previous'
                          active: false
                        -
                          url: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                          label: '1'
                          active: true
                        -
                          url: null
                          label: 'Next &raquo;'
                          active: false
                      next_page_url: null
                      path: 'https://vendors.getlinkk.com/api/v1/service-types'
                      per_page: 5
                      prev_page_url: null
                      to: null
                      total: 0
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        current_page: 1
                        data: []
                        first_page_url: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from: null
                        last_page: 1
                        last_page_url: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        next_page_url: null
                        path: 'https://vendors.getlinkk.com/api/v1/service-types'
                        per_page: 5
                        prev_page_url: null
                        to: null
                        total: 0
                    items:
                      type: object
                      properties:
                        current_page:
                          type: integer
                          example: 1
                        data:
                          type: array
                          example: []
                        first_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        from:
                          type: string
                          example: null
                        last_page:
                          type: integer
                          example: 1
                        last_page_url:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                        links:
                          type: array
                          example:
                            -
                              url: null
                              label: '&laquo; Previous'
                              active: false
                            -
                              url: 'https://vendors.getlinkk.com/api/v1/service-types?per_page=5&before=2023-01-23%2012%3A00%3A00&after=2023-01-01&page=1'
                              label: '1'
                              active: true
                            -
                              url: null
                              label: 'Next &raquo;'
                              active: false
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              label:
                                type: string
                                example: '&laquo; Previous'
                              active:
                                type: boolean
                                example: false
                        next_page_url:
                          type: string
                          example: null
                        path:
                          type: string
                          example: 'https://vendors.getlinkk.com/api/v1/service-types'
                        per_page:
                          type: integer
                          example: 5
                        prev_page_url:
                          type: string
                          example: null
                        to:
                          type: string
                          example: null
                        total:
                          type: integer
                          example: 0
      tags:
        - 'Service Types'
    post:
      summary: 'Service type creation'
      operationId: serviceTypeCreation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Service Types'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 50 characters.'
                  example: a
                description:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: 'Itaque quis cupiditate vel consequuntur sed et nihil veniam.'
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: pfxxqzbtuvsqpsnofbfbh
              required:
                - name
                - description
  '/api/v1/service-types/{identifier}':
    get:
      summary: 'Retrieve a specific service type'
      operationId: retrieveASpecificServiceType
      description: ''
      parameters: []
      responses:
        500:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Server Error'
                properties:
                  message:
                    type: string
                    example: 'Server Error'
      tags:
        - 'Service Types'
    patch:
      summary: 'Service type update'
      operationId: serviceTypeUpdate
      description: 'Active status changes will be ignored. Please use the archive and activate endpoints for that purpose.'
      parameters: []
      responses: {  }
      tags:
        - 'Service Types'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 50 characters.'
                  example: ktyu
                description:
                  type: string
                  description: 'Must not be greater than 100 characters.'
                  example: 'Qui nulla et aut ab non numquam.'
                external_id:
                  type: string
                  description: 'Must not be greater than 200 characters.'
                  example: qrnmex
              required:
                - name
                - description
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the service type: id, external_id.'
        example: temporibus
        required: true
        schema:
          type: string
  '/api/v1/service-types/{identifier}/archive':
    patch:
      summary: 'Service type archive'
      operationId: serviceTypeArchive
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Service Types'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the service type to be archived: id, external_id.'
        example: nihil
        required: true
        schema:
          type: string
  '/api/v1/service-types/{identifier}/activate':
    patch:
      summary: 'Service type activate'
      operationId: serviceTypeActivate
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Service Types'
    parameters:
      -
        in: path
        name: identifier
        description: 'Provide any of the following values to identify the service type to be (re)activated: id, external_id.'
        example: inventore
        required: true
        schema:
          type: string
  /api/v1/uom:
    get:
      summary: 'Retrieve list of units of measure'
      operationId: retrieveListOfUnitsOfMeasure
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  body:
                    -
                      id: 12
                      name: bbl
                      created_at: '2018-06-15T20:39:34.000000Z'
                      updated_at: '2018-06-15T20:39:34.000000Z'
                    -
                      id: 15
                      name: case
                      created_at: '2023-03-30T22:24:46.000000Z'
                      updated_at: '2023-03-30T22:24:46.000000Z'
                    -
                      id: 14
                      name: day
                      created_at: '2019-02-01T22:42:46.000000Z'
                      updated_at: '2019-02-01T22:42:46.000000Z'
                    -
                      id: 22
                      name: DEG
                      created_at: '2025-06-12T13:52:04.000000Z'
                      updated_at: '2025-06-12T13:52:04.000000Z'
                    -
                      id: 18
                      name: drum
                      created_at: '2023-03-30T22:24:46.000000Z'
                      updated_at: '2023-03-30T22:24:46.000000Z'
                    -
                      id: 13
                      name: each
                      created_at: '2018-06-15T20:39:34.000000Z'
                      updated_at: '2018-06-15T20:39:34.000000Z'
                    -
                      id: 21
                      name: empty
                      created_at: '2025-06-12T13:52:04.000000Z'
                      updated_at: '2025-06-12T13:52:04.000000Z'
                    -
                      id: 5
                      name: ft
                      created_at: '2016-01-25T19:27:41.000000Z'
                      updated_at: '-000001-11-30T00:00:00.000000Z'
                    -
                      id: 20
                      name: full
                      created_at: '2025-06-12T13:52:04.000000Z'
                      updated_at: '2025-06-12T13:52:04.000000Z'
                    -
                      id: 1
                      name: gal
                      created_at: '2016-01-25T19:12:02.000000Z'
                      updated_at: '2016-01-22T00:00:00.000000Z'
                    -
                      id: 4
                      name: gr
                      created_at: '2016-01-25T19:27:41.000000Z'
                      updated_at: '-000001-11-30T00:00:00.000000Z'
                    -
                      id: 11
                      name: Hr
                      created_at: '2017-01-13T14:50:15.000000Z'
                      updated_at: '2017-01-13T14:50:15.000000Z'
                    -
                      id: 16
                      name: keg
                      created_at: '2023-03-30T22:24:46.000000Z'
                      updated_at: '2023-03-30T22:24:46.000000Z'
                    -
                      id: 3
                      name: kg
                      created_at: '2016-01-25T19:27:41.000000Z'
                      updated_at: '-000001-11-30T00:00:00.000000Z'
                    -
                      id: 7
                      name: km
                      created_at: '2016-01-25T19:27:41.000000Z'
                      updated_at: '-000001-11-30T00:00:00.000000Z'
                    -
                      id: 9
                      name: lb
                      created_at: '2016-01-25T19:27:41.000000Z'
                      updated_at: '-000001-11-30T00:00:00.000000Z'
                    -
                      id: 8
                      name: m
                      created_at: '2016-01-25T19:27:41.000000Z'
                      updated_at: '-000001-11-30T00:00:00.000000Z'
                    -
                      id: 17
                      name: pail
                      created_at: '2023-03-30T22:24:46.000000Z'
                      updated_at: '2023-03-30T22:24:46.000000Z'
                    -
                      id: 10
                      name: ton
                      created_at: '2016-01-25T19:27:41.000000Z'
                      updated_at: '-000001-11-30T00:00:00.000000Z'
                    -
                      id: 19
                      name: tube
                      created_at: '2023-10-09T16:01:56.000000Z'
                      updated_at: '2023-10-09T16:01:56.000000Z'
                    -
                      id: 2
                      name: unit
                      created_at: '2016-01-25T19:12:14.000000Z'
                      updated_at: '2016-01-25T00:00:00.000000Z'
                    -
                      id: 6
                      name: yd
                      created_at: '2016-01-25T19:27:41.000000Z'
                      updated_at: '-000001-11-30T00:00:00.000000Z'
                properties:
                  success:
                    type: boolean
                    example: true
                  body:
                    type: array
                    example:
                      -
                        id: 12
                        name: bbl
                        created_at: '2018-06-15T20:39:34.000000Z'
                        updated_at: '2018-06-15T20:39:34.000000Z'
                      -
                        id: 15
                        name: case
                        created_at: '2023-03-30T22:24:46.000000Z'
                        updated_at: '2023-03-30T22:24:46.000000Z'
                      -
                        id: 14
                        name: day
                        created_at: '2019-02-01T22:42:46.000000Z'
                        updated_at: '2019-02-01T22:42:46.000000Z'
                      -
                        id: 22
                        name: DEG
                        created_at: '2025-06-12T13:52:04.000000Z'
                        updated_at: '2025-06-12T13:52:04.000000Z'
                      -
                        id: 18
                        name: drum
                        created_at: '2023-03-30T22:24:46.000000Z'
                        updated_at: '2023-03-30T22:24:46.000000Z'
                      -
                        id: 13
                        name: each
                        created_at: '2018-06-15T20:39:34.000000Z'
                        updated_at: '2018-06-15T20:39:34.000000Z'
                      -
                        id: 21
                        name: empty
                        created_at: '2025-06-12T13:52:04.000000Z'
                        updated_at: '2025-06-12T13:52:04.000000Z'
                      -
                        id: 5
                        name: ft
                        created_at: '2016-01-25T19:27:41.000000Z'
                        updated_at: '-000001-11-30T00:00:00.000000Z'
                      -
                        id: 20
                        name: full
                        created_at: '2025-06-12T13:52:04.000000Z'
                        updated_at: '2025-06-12T13:52:04.000000Z'
                      -
                        id: 1
                        name: gal
                        created_at: '2016-01-25T19:12:02.000000Z'
                        updated_at: '2016-01-22T00:00:00.000000Z'
                      -
                        id: 4
                        name: gr
                        created_at: '2016-01-25T19:27:41.000000Z'
                        updated_at: '-000001-11-30T00:00:00.000000Z'
                      -
                        id: 11
                        name: Hr
                        created_at: '2017-01-13T14:50:15.000000Z'
                        updated_at: '2017-01-13T14:50:15.000000Z'
                      -
                        id: 16
                        name: keg
                        created_at: '2023-03-30T22:24:46.000000Z'
                        updated_at: '2023-03-30T22:24:46.000000Z'
                      -
                        id: 3
                        name: kg
                        created_at: '2016-01-25T19:27:41.000000Z'
                        updated_at: '-000001-11-30T00:00:00.000000Z'
                      -
                        id: 7
                        name: km
                        created_at: '2016-01-25T19:27:41.000000Z'
                        updated_at: '-000001-11-30T00:00:00.000000Z'
                      -
                        id: 9
                        name: lb
                        created_at: '2016-01-25T19:27:41.000000Z'
                        updated_at: '-000001-11-30T00:00:00.000000Z'
                      -
                        id: 8
                        name: m
                        created_at: '2016-01-25T19:27:41.000000Z'
                        updated_at: '-000001-11-30T00:00:00.000000Z'
                      -
                        id: 17
                        name: pail
                        created_at: '2023-03-30T22:24:46.000000Z'
                        updated_at: '2023-03-30T22:24:46.000000Z'
                      -
                        id: 10
                        name: ton
                        created_at: '2016-01-25T19:27:41.000000Z'
                        updated_at: '-000001-11-30T00:00:00.000000Z'
                      -
                        id: 19
                        name: tube
                        created_at: '2023-10-09T16:01:56.000000Z'
                        updated_at: '2023-10-09T16:01:56.000000Z'
                      -
                        id: 2
                        name: unit
                        created_at: '2016-01-25T19:12:14.000000Z'
                        updated_at: '2016-01-25T00:00:00.000000Z'
                      -
                        id: 6
                        name: yd
                        created_at: '2016-01-25T19:27:41.000000Z'
                        updated_at: '-000001-11-30T00:00:00.000000Z'
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 12
                        name:
                          type: string
                          example: bbl
                        created_at:
                          type: string
                          example: '2018-06-15T20:39:34.000000Z'
                        updated_at:
                          type: string
                          example: '2018-06-15T20:39:34.000000Z'
      tags:
        - 'Units of Measure'
tags:
  -
    name: 'Billing Locations'
    description: ''
  -
    name: Customers
    description: ''
  -
    name: Endpoints
    description: ''
  -
    name: Jobs
    description: ''
  -
    name: 'Material Groups'
    description: ''
  -
    name: Materials
    description: ''
  -
    name: Miscellaneous
    description: ''
  -
    name: Orders
    description: ''
  -
    name: 'Service Areas'
    description: ''
  -
    name: 'Service Types'
    description: ''
  -
    name: 'Units of Measure'
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: basic
      description: null
security:
  -
    default: []
