openapi: 3.0.3
info:
  title: Procurify API Documentation account-codes requisitions API
  version: ''
  description: '

    # Disclaimer


    - Procurify’s API is evolving and is subject to change at any time. Additionally, aspects of the API are undocumented, including certain methods, events, and properties. Given that both documented and undocumented aspects of the Procurify API may change at any time, the client relies on the API at their own risk.

    - Client (and/or client’s representative) is responsible for building, testing, and maintaining any API connection between Procurify and any other tool.  Procurify’s responsibility strictly involves providing support on clarifications in regards to the issued API document.

    - Procurify’s API is offered on an “as is” and “as available” basis, without warranties of any kind. By accepting this agreement, you agree that you have read the current API documentation, and accept the API functionality in its current state including current limitations. For questions and clarification around the documentation, please contact support@procurify.com.

    - In accordance with Section 2.(b) of our Subscription Services Agreement, Procurify reserves the right to deny access to our API at any time. If your API requests are too large and time out, contact us immediately to avoid possible suspension of access.

    - You may not attempt to reverse engineer or otherwise derive source code, trade secrets, or know-how in the Procurify API or portion thereof. You may not use the Procurify API to replicate or compete with core products or services offered by Procurify.

    '
servers:
- url: https://{user_domain}.procurify.com
  description: Your Procurify domain
  variables:
    user_domain:
      default: your-domain
      description: Your procurify domain
tags:
- name: requisitions
paths:
  /api/v2/global/order_items/:
    get:
      operationId: global_order_items_list
      description: '**Order Item Status Codes**


        | Order Item Type          | Code      | Description                       |

        |--------------------------|-----------|-----------------------------------|

        | PURCHASE_PENDING         | 0         | Approved but not purchased.       |

        | PURCHASE_INUSE           | 1         | Added to purchaser''s PO list.     |

        | RECEIVE_PENDING          | 2         | Purchased but not yet received, i.e. receivedPassQty == 0. |

        | RECEIVED                 | 3         | Fully received, i.e. receivedPassQty == quantity. |

        | REJECTED_FOR_PURCHASE    | 4         | Rejected at procurement, i.e. denied. |

        | RECEIVE_PARTIAL          | 5         | Partially received, i.e. receivedPassQty != quantity and receivedPassQty > 0. |

        | FULFILLED                | 6         | Received but unused. |

        | APPROVAL_DENIED          | 7         | Denied in approval routing (by approver). |

        | REQUEST_DRAFT            | 8         | Preparing for draft instead of using sessions. |'
      summary: Get All Order Items
      parameters:
      - in: query
        name: account
        schema:
          type: integer
      - in: query
        name: account_code
        schema:
          type: integer
        description: Account Code
      - in: query
        name: active
        schema:
          type: boolean
      - in: query
        name: approved_datetime_0
        schema:
          type: string
          format: date
        description: Approved Date
      - in: query
        name: approved_datetime_1
        schema:
          type: string
          format: date
        description: Approved Date
      - in: query
        name: approved_price
        schema:
          type: number
      - in: query
        name: approved_quantity
        schema:
          type: number
      - in: query
        name: approver
        schema:
          type: number
      - in: query
        name: approver_id
        schema:
          type: number
      - in: query
        name: branch
        schema:
          type: integer
        description: Location
      - in: query
        name: catalog
        schema:
          type: boolean
      - in: query
        name: catalog_item
        schema:
          type: string
        description: A comma-separated list of integers.
      - in: query
        name: currency
        schema:
          type: integer
      - in: query
        name: department
        schema:
          type: integer
        description: Department
      - in: query
        name: departments
        schema:
          type: string
        description: A comma-separated list of integers.
      - in: query
        name: exclude
        schema:
          type: string
        description: A comma-separated list of integers.
      - in: query
        name: exclude_punchout
        schema:
          type: boolean
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      - in: query
        name: fulfilment_status
        schema:
          type: string
      - in: query
        name: is_purchased
        schema:
          type: boolean
      - in: query
        name: is_recurring
        schema:
          type: boolean
      - in: query
        name: last_changed_by
        schema:
          type: integer
      - in: query
        name: last_modified_0
        schema:
          type: string
          format: date
        description: Last Modified Date
      - in: query
        name: last_modified_1
        schema:
          type: string
          format: date
        description: Last Modified Date
      - in: query
        name: lineComment
        schema:
          type: string
      - in: query
        name: location
        schema:
          type: integer
        description: Location
      - in: query
        name: locations
        schema:
          type: string
        description: A comma-separated list of integers.
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: num
        schema:
          type: string
      - in: query
        name: orderNum
        schema:
          type: integer
      - in: query
        name: orderNum__status
        schema:
          type: integer
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        description: '* `0` - Pending

          * `1` - Approved

          * `2` - Denied

          * `3` - Purchased

          * `4` - Cancelled

          * `5` - Received

          * `6` - Draft'
      - name: order_by
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: order_created_date_0
        schema:
          type: string
          format: date
        description: Order Created Date
      - in: query
        name: order_created_date_1
        schema:
          type: string
          format: date
        description: Order Created Date
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: po_created_date_0
        schema:
          type: string
          format: date
        description: Purchased Date
      - in: query
        name: po_created_date_1
        schema:
          type: string
          format: date
        description: Purchased Date
      - in: query
        name: po_vendor
        schema:
          type: integer
        description: Purchased Vendor
      - in: query
        name: pref_vendor
        schema:
          type: integer
      - in: query
        name: price
        schema:
          type: number
      - in: query
        name: purchase_agreement
        schema:
          type: number
      - in: query
        name: purchased_date_0
        schema:
          type: string
          format: date
        description: Purchased Date
      - in: query
        name: purchased_date_1
        schema:
          type: string
          format: date
        description: Purchased Date
      - in: query
        name: purchaser
        schema:
          type: integer
      - in: query
        name: quantity
        schema:
          type: number
      - in: query
        name: receivedFailQty
        schema:
          type: number
      - in: query
        name: receivedPassQty
        schema:
          type: number
      - in: query
        name: requester
        schema:
          type: integer
        description: Requester
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sku
        schema:
          type: string
      - in: query
        name: status
        schema:
          type: integer
          nullable: true
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
        description: '* `0` - Purchase Pending

          * `1` - Purchaser In-Use

          * `2` - Receive Pending

          * `3` - Received

          * `4` - Rejected for Purchase

          * `5` - Partial Received

          * `6` - Fulfilled

          * `7` - Approval Denied

          * `8` - Request Draft'
      - in: query
        name: type
        schema:
          type: integer
          enum:
          - 0
          - 1
          - 2
        description: '* `0` - One Time

          * `1` - Recurring

          * `2` - Blanket'
      - in: query
        name: unit
        schema:
          type: string
      tags:
      - requisitions
      security:
      - RemoteAuthentication: []
      - M2MAuthentication: []
      - BasicAuthentication: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOrderItemList'
            text/csv:
              schema:
                $ref: '#/components/schemas/PaginatedOrderItemList'
          description: ''
  /api/v2/global/orders/:
    get:
      operationId: global_orders_list
      description: '**Order Status Codes**


        | Order Type          | Code      |

        |---------------------|-----------|

        | PENDING             | 0         |

        | APPROVED            | 1         |

        | REJECTED            | 2         |

        | PURCHASED           | 3         |

        | CANCELLED (legacy)  | 4         |

        | RECEIVED            | 5         |

        | DRAFT               | 6         |'
      summary: Get All Orders
      parameters:
      - in: query
        name: account_code
        schema:
          type: integer
        description: Account Code
      - in: query
        name: branch
        schema:
          type: integer
      - in: query
        name: dateRequired
        schema:
          type: string
          format: date-time
      - in: query
        name: date_0
        schema:
          type: string
          format: date
        description: Date
      - in: query
        name: date_1
        schema:
          type: string
          format: date
        description: Date
      - in: query
        name: department
        schema:
          type: integer
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      - in: query
        name: has_blanket_order_items
        schema:
          type: boolean
      - in: query
        name: is_punchout
        schema:
          type: boolean
      - in: query
        name: lineCount
        schema:
          type: integer
      - in: query
        name: location
        schema:
          type: integer
      - in: query
        name: modified_date_0
        schema:
          type: string
          format: date
        description: Last Modified Date
      - in: query
        name: modified_date_1
        schema:
          type: string
          format: date
        description: Last Modified Date
      - in: query
        name: order
        schema:
          type: number
        description: Order
      - name: order_by
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: pref_vendor
        schema:
          type: integer
        description: Preferred Vendor
      - in: query
        name: requester
        schema:
          type: integer
        description: Requester
      - in: query
        name: required_date_0
        schema:
          type: string
          format: date
        description: Date Required
      - in: query
        name: required_date_1
        schema:
          type: string
          format: date
        description: Date Required
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: status
        schema:
          type: integer
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
        description: '* `0` - Pending

          * `1` - Approved

          * `2` - Denied

          * `3` - Purchased

          * `4` - Cancelled

          * `5` - Received

          * `6` - Draft'
      - in: query
        name: totalPrice
        schema:
          type: number
      tags:
      - requisitions
      security:
      - RemoteAuthentication: []
      - M2MAuthentication: []
      - BasicAuthentication: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOrderReadList'
            text/csv:
              schema:
                $ref: '#/components/schemas/PaginatedOrderReadList'
          description: ''
  /api/v3/requisitions/:
    post:
      operationId: requisitions_create
      summary: Creating a requisition
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      tags:
      - requisitions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequisitionCreateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RequisitionCreateRequest'
          ? ''
          : schema:
              $ref: '#/components/schemas/RequisitionCreateRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/RequisitionCreateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RequisitionCreateRequest'
        required: true
      security:
      - RemoteAuthentication: []
      - M2MAuthentication: []
      - BasicAuthentication: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequisitionReadSerializerSingle'
            text/csv:
              schema:
                $ref: '#/components/schemas/RequisitionReadSerializerSingle'
          description: ''
components:
  schemas:
    PaginatedOrderItemList:
      type: object
      properties:
        metadata:
          type: object
          properties:
            pagination:
              type: object
              properties:
                count:
                  type: integer
                  example: 10
                next:
                  type: string
                  nullable: true
                  format: uri
                  example: null
                previous:
                  type: string
                  nullable: true
                  format: uri
                  example: null
                page_size:
                  type: integer
                  example: 10
                num_pages:
                  type: integer
                  example: 1
                current_page:
                  type: integer
                  example: 1
          example:
            pagination:
              count: 10
              next: null
              previous: null
              page_size: 10
              num_pages: 1
              current_page: 1
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
    RequisitionReadSerializerSingle:
      type: object
      properties:
        metadata:
          type: object
          additionalProperties: {}
          default: {}
        data:
          $ref: '#/components/schemas/RequisitionRead'
      required:
      - data
    OrderItemTypeEnum:
      enum:
      - 0
      - 1
      - 2
      type: integer
      description: '* `0` - One Time

        * `1` - Recurring

        * `2` - Blanket'
    UserProfileRead:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        firstName:
          type: string
          maxLength: 100
        lastName:
          type: string
          maxLength: 100
        email:
          type: string
          format: email
          maxLength: 254
        department:
          allOf:
          - $ref: '#/components/schemas/SimpleDepartment'
          nullable: true
          type: object
      required:
      - department
      - email
    BranchSummary:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 150
      required:
      - name
    PaginatedOrderReadList:
      type: object
      properties:
        metadata:
          type: object
          properties:
            pagination:
              type: object
              properties:
                count:
                  type: integer
                  example: 10
                next:
                  type: string
                  nullable: true
                  format: uri
                  example: null
                previous:
                  type: string
                  nullable: true
                  format: uri
                  example: null
                page_size:
                  type: integer
                  example: 10
                num_pages:
                  type: integer
                  example: 1
                current_page:
                  type: integer
                  example: 1
          example:
            pagination:
              count: 10
              next: null
              previous: null
              page_size: 10
              num_pages: 1
              current_page: 1
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrderRead'
    ApprovalWorkflowCurrentStep:
      type: object
      properties:
        status:
          type: integer
        step_number:
          type: integer
        group_id:
          type: integer
        group_name:
          type: string
        approver:
          $ref: '#/components/schemas/ApprovalWorkflowApproverGroup'
      required:
      - approver
      - group_id
      - group_name
      - status
      - step_number
    ApprovalWorkflowApproverGroup:
      type: object
      properties:
        approvers:
          type: array
          items:
            $ref: '#/components/schemas/ApprovalWorkflowApprover'
        is_pooled:
          type: boolean
        level:
          type: integer
        group_id:
          type: integer
        group_name:
          type: string
      required:
      - approvers
      - group_id
      - group_name
      - is_pooled
      - level
    LocationTimezoneEnum:
      enum:
      - Africa/Abidjan
      - Africa/Accra
      - Africa/Addis_Ababa
      - Africa/Algiers
      - Africa/Asmara
      - Africa/Bamako
      - Africa/Bangui
      - Africa/Banjul
      - Africa/Bissau
      - Africa/Blantyre
      - Africa/Brazzaville
      - Africa/Bujumbura
      - Africa/Cairo
      - Africa/Casablanca
      - Africa/Ceuta
      - Africa/Conakry
      - Africa/Dakar
      - Africa/Dar_es_Salaam
      - Africa/Djibouti
      - Africa/Douala
      - Africa/El_Aaiun
      - Africa/Freetown
      - Africa/Gaborone
      - Africa/Harare
      - Africa/Johannesburg
      - Africa/Juba
      - Africa/Kampala
      - Africa/Khartoum
      - Africa/Kigali
      - Africa/Kinshasa
      - Africa/Lagos
      - Africa/Libreville
      - Africa/Lome
      - Africa/Luanda
      - Africa/Lubumbashi
      - Africa/Lusaka
      - Africa/Malabo
      - Africa/Maputo
      - Africa/Maseru
      - Africa/Mbabane
      - Africa/Mogadishu
      - Africa/Monrovia
      - Africa/Nairobi
      - Africa/Ndjamena
      - Africa/Niamey
      - Africa/Nouakchott
      - Africa/Ouagadougou
      - Africa/Porto-Novo
      - Africa/Sao_Tome
      - Africa/Tripoli
      - Africa/Tunis
      - Africa/Windhoek
      - America/Adak
      - America/Anchorage
      - America/Anguilla
      - America/Antigua
      - America/Araguaina
      - America/Argentina/Buenos_Aires
      - America/Argentina/Catamarca
      - America/Argentina/Cordoba
      - America/Argentina/Jujuy
      - America/Argentina/La_Rioja
      - America/Argentina/Mendoza
      - America/Argentina/Rio_Gallegos
      - America/Argentina/Salta
      - America/Argentina/San_Juan
      - America/Argentina/San_Luis
      - America/Argentina/Tucuman
      - America/Argentina/Ushuaia
      - America/Aruba
      - America/Asuncion
      - America/Atikokan
      - America/Bahia
      - America/Bahia_Banderas
      - America/Barbados
      - America/Belem
      - America/Belize
      - America/Blanc-Sablon
      - America/Boa_Vista
      - America/Bogota
      - America/Boise
      - America/Cambridge_Bay
      - America/Campo_Grande
      - America/Cancun
      - America/Caracas
      - America/Cayenne
      - America/Cayman
      - America/Chicago
      - America/Chihuahua
      - America/Costa_Rica
      - America/Creston
      - America/Cuiaba
      - America/Curacao
      - America/Danmarkshavn
      - America/Dawson
      - America/Dawson_Creek
      - America/Denver
      - America/Detroit
      - America/Dominica
      - America/Edmonton
      - America/Eirunepe
      - America/El_Salvador
      - America/Fort_Nelson
      - America/Fortaleza
      - America/Glace_Bay
      - America/Godthab
      - America/Goose_Bay
      - America/Grand_Turk
      - America/Grenada
      - America/Guadeloupe
      - America/Guatemala
      - America/Guayaquil
      - America/Guyana
      - America/Halifax
      - America/Havana
      - America/Hermosillo
      - America/Indiana/Indianapolis
      - America/Indiana/Knox
      - America/Indiana/Marengo
      - America/Indiana/Petersburg
      - America/Indiana/Tell_City
      - America/Indiana/Vevay
      - America/Indiana/Vincennes
      - America/Indiana/Winamac
      - America/Inuvik
      - America/Iqaluit
      - America/Jamaica
      - America/Juneau
      - America/Kentucky/Louisville
      - America/Kentucky/Monticello
      - America/Kralendijk
      - America/La_Paz
      - America/Lima
      - America/Los_Angeles
      - America/Lower_Princes
      - America/Maceio
      - America/Managua
      - America/Manaus
      - America/Marigot
      - America/Martinique
      - America/Matamoros
      - America/Mazatlan
      - America/Menominee
      - America/Merida
      - America/Metlakatla
      - America/Mexico_City
      - America/Miquelon
      - America/Moncton
      - America/Monterrey
      - America/Montevideo
      - America/Montserrat
      - America/Nassau
      - America/New_York
      - America/Nipigon
      - America/Nome
      - America/Noronha
      - America/North_Dakota/Beulah
      - America/North_Dakota/Center
      - America/North_Dakota/New_Salem
      - America/Ojinaga
      - America/Panama
      - America/Pangnirtung
      - America/Paramaribo
      - America/Phoenix
      - America/Port-au-Prince
      - America/Port_of_Spain
      - America/Porto_Velho
      - America/Puerto_Rico
      - America/Punta_Arenas
      - America/Rainy_River
      - America/Rankin_Inlet
      - America/Recife
      - America/Regina
      - America/Resolute
      - America/Rio_Branco
      - America/Santarem
      - America/Santiago
      - America/Santo_Domingo
      - America/Sao_Paulo
      - America/Scoresbysund
      - America/Sitka
      - America/St_Barthelemy
      - America/St_Johns
      - America/St_Kitts
      - America/St_Lucia
      - America/St_Thomas
      - America/St_Vincent
      - America/Swift_Current
      - America/Tegucigalpa
      - America/Thule
      - America/Thunder_Bay
      - America/Tijuana
      - America/Toronto
      - America/Tortola
      - America/Vancouver
      - America/Whitehorse
      - America/Winnipeg
      - America/Yakutat
      - America/Yellowknife
      - Antarctica/Casey
      - Antarctica/Davis
      - Antarctica/DumontDUrville
      - Antarctica/Macquarie
      - Antarctica/Mawson
      - Antarctica/McMurdo
      - Antarctica/Palmer
      - Antarctica/Rothera
      - Antarctica/Syowa
      - Antarctica/Troll
      - Antarctica/Vostok
      - Arctic/Longyearbyen
      - Asia/Aden
      - Asia/Almaty
      - Asia/Amman
      - Asia/Anadyr
      - Asia/Aqtau
      - Asia/Aqtobe
      - Asia/Ashgabat
      - Asia/Atyrau
      - Asia/Baghdad
      - Asia/Bahrain
      - Asia/Baku
      - Asia/Bangkok
      - Asia/Barnaul
      - Asia/Beirut
      - Asia/Bishkek
      - Asia/Brunei
      - Asia/Chita
      - Asia/Choibalsan
      - Asia/Colombo
      - Asia/Damascus
      - Asia/Dhaka
      - Asia/Dili
      - Asia/Dubai
      - Asia/Dushanbe
      - Asia/Famagusta
      - Asia/Gaza
      - Asia/Hebron
      - Asia/Ho_Chi_Minh
      - Asia/Hong_Kong
      - Asia/Hovd
      - Asia/Irkutsk
      - Asia/Jakarta
      - Asia/Jayapura
      - Asia/Jerusalem
      - Asia/Kabul
      - Asia/Kamchatka
      - Asia/Karachi
      - Asia/Kathmandu
      - Asia/Khandyga
      - Asia/Kolkata
      - Asia/Krasnoyarsk
      - Asia/Kuala_Lumpur
      - Asia/Kuching
      - Asia/Kuwait
      - Asia/Macau
      - Asia/Magadan
      - Asia/Makassar
      - Asia/Manila
      - Asia/Muscat
      - Asia/Nicosia
      - Asia/Novokuznetsk
      - Asia/Novosibirsk
      - Asia/Omsk
      - Asia/Oral
      - Asia/Phnom_Penh
      - Asia/Pontianak
      - Asia/Pyongyang
      - Asia/Qatar
      - Asia/Qyzylorda
      - Asia/Riyadh
      - Asia/Sakhalin
      - Asia/Samarkand
      - Asia/Seoul
      - Asia/Shanghai
      - Asia/Singapore
      - Asia/Srednekolymsk
      - Asia/Taipei
      - Asia/Tashkent
      - Asia/Tbilisi
      - Asia/Tehran
      - Asia/Thimphu
      - Asia/Tokyo
      - Asia/Tomsk
      - Asia/Ulaanbaatar
      - Asia/Urumqi
      - Asia/Ust-Nera
      - Asia/Vientiane
      - Asia/Vladivostok
      - Asia/Yakutsk
      - Asia/Yangon
      - Asia/Yekaterinburg
      - Asia/Yerevan
      - Atlantic/Azores
      - Atlantic/Bermuda
      - Atlantic/Canary
      - Atlantic/Cape_Verde
      - Atlantic/Faroe
      - Atlantic/Madeira
      - Atlantic/Reykjavik
      - Atlantic/South_Georgia
      - Atlantic/St_Helena
      - Atlantic/Stanley
      - Australia/Adelaide
      - Australia/Brisbane
      - Australia/Broken_Hill
      - Australia/Currie
      - Australia/Darwin
      - Australia/Eucla
      - Australia/Hobart
      - Australia/Lindeman
      - Australia/Lord_Howe
      - Australia/Melbourne
      - Australia/Perth
      - Australia/Sydney
      - Canada/Atlantic
      - Canada/Central
      - Canada/Eastern
      - Canada/Mountain
      - Canada/Newfoundland
      - Canada/Pacific
      - Europe/Amsterdam
      - Europe/Andorra
      - Europe/Astrakhan
      - Europe/Athens
      - Europe/Belgrade
      - Europe/Berlin
      - Europe/Bratislava
      - Europe/Brussels
      - Europe/Bucharest
      - Europe/Budapest
      - Europe/Busingen
      - Europe/Chisinau
      - Europe/Copenhagen
      - Europe/Dublin
      - Europe/Gibraltar
      - Europe/Guernsey
      - Europe/Helsinki
      - Europe/Isle_of_Man
      - Europe/Istanbul
      - Europe/Jersey
      - Europe/Kaliningrad
      - Europe/Kiev
      - Europe/Kirov
      - Europe/Lisbon
      - Europe/Ljubljana
      - Europe/London
      - Europe/Luxembourg
      - Europe/Madrid
      - Europe/Malta
      - Europe/Mariehamn
      - Europe/Minsk
      - Europe/Monaco
      - Europe/Moscow
      - Europe/Oslo
      - Europe/Paris
      - Europe/Podgorica
      - Europe/Prague
      - Europe/Riga
      - Europe/Rome
      - Europe/Samara
      - Europe/San_Marino
      - Europe/Sarajevo
      - Europe/Saratov
      - Europe/Simferopol
      - Europe/Skopje
      - Europe/Sofia
      - Europe/Stockholm
      - Europe/Tallinn
      - Europe/Tirane
      - Europe/Ulyanovsk
      - Europe/Uzhgorod
      - Europe/Vaduz
      - Europe/Vatican
      - Europe/Vienna
      - Europe/Vilnius
      - Europe/Volgograd
      - Europe/Warsaw
      - Europe/Zagreb
      - Europe/Zaporozhye
      - Europe/Zurich
      - GMT
      - Indian/Antananarivo
      - Indian/Chagos
      - Indian/Christmas
      - Indian/Cocos
      - Indian/Comoro
      - Indian/Kerguelen
      - Indian/Mahe
      - Indian/Maldives
      - Indian/Mauritius
      - Indian/Mayotte
      - Indian/Reunion
      - Pacific/Apia
      - Pacific/Auckland
      - Pacific/Bougainville
      - Pacific/Chatham
      - Pacific/Chuuk
      - Pacific/Easter
      - Pacific/Efate
      - Pacific/Enderbury
      - Pacific/Fakaofo
      - Pacific/Fiji
      - Pacific/Funafuti
      - Pacific/Galapagos
      - Pacific/Gambier
      - Pacific/Guadalcanal
      - Pacific/Guam
      - Pacific/Honolulu
      - Pacific/Kiritimati
      - Pacific/Kosrae
      - Pacific/Kwajalein
      - Pacific/Majuro
      - Pacific/Marquesas
      - Pacific/Midway
      - Pacific/Nauru
      - Pacific/Niue
      - Pacific/Norfolk
      - Pacific/Noumea
      - Pacific/Pago_Pago
      - Pacific/Palau
      - Pacific/Pitcairn
      - Pacific/Pohnpei
      - Pacific/Port_Moresby
      - Pacific/Rarotonga
      - Pacific/Saipan
      - Pacific/Tahiti
      - Pacific/Tarawa
      - Pacific/Tongatapu
      - Pacific/Wake
      - Pacific/Wallis
      - US/Alaska
      - US/Arizona
      - US/Central
      - US/Eastern
      - US/Hawaii
      - US/Mountain
      - US/Pacific
      - UTC
      type: string
      description: '* `Africa/Abidjan` - Africa/Abidjan

        * `Africa/Accra` - Africa/Accra

        * `Africa/Addis_Ababa` - Africa/Addis_Ababa

        * `Africa/Algiers` - Africa/Algiers

        * `Africa/Asmara` - Africa/Asmara

        * `Africa/Bamako` - Africa/Bamako

        * `Africa/Bangui` - Africa/Bangui

        * `Africa/Banjul` - Africa/Banjul

        * `Africa/Bissau` - Africa/Bissau

        * `Africa/Blantyre` - Africa/Blantyre

        * `Africa/Brazzaville` - Africa/Brazzaville

        * `Africa/Bujumbura` - Africa/Bujumbura

        * `Africa/Cairo` - Africa/Cairo

        * `Africa/Casablanca` - Africa/Casablanca

        * `Africa/Ceuta` - Africa/Ceuta

        * `Africa/Conakry` - Africa/Conakry

        * `Africa/Dakar` - Africa/Dakar

        * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam

        * `Africa/Djibouti` - Africa/Djibouti

        * `Africa/Douala` - Africa/Douala

        * `Africa/El_Aaiun` - Africa/El_Aaiun

        * `Africa/Freetown` - Africa/Freetown

        * `Africa/Gaborone` - Africa/Gaborone

        * `Africa/Harare` - Africa/Harare

        * `Africa/Johannesburg` - Africa/Johannesburg

        * `Africa/Juba` - Africa/Juba

        * `Africa/Kampala` - Africa/Kampala

        * `Africa/Khartoum` - Africa/Khartoum

        * `Africa/Kigali` - Africa/Kigali

        * `Africa/Kinshasa` - Africa/Kinshasa

        * `Africa/Lagos` - Africa/Lagos

        * `Africa/Libreville` - Africa/Libreville

        * `Africa/Lome` - Africa/Lome

        * `Africa/Luanda` - Africa/Luanda

        * `Africa/Lubumbashi` - Africa/Lubumbashi

        * `Africa/Lusaka` - Africa/Lusaka

        * `Africa/Malabo` - Africa/Malabo

        * `Africa/Maputo` - Africa/Maputo

        * `Africa/Maseru` - Africa/Maseru

        * `Africa/Mbabane` - Africa/Mbabane

        * `Africa/Mogadishu` - Africa/Mogadishu

        * `Africa/Monrovia` - Africa/Monrovia

        * `Africa/Nairobi` - Africa/Nairobi

        * `Africa/Ndjamena` - Africa/Ndjamena

        * `Africa/Niamey` - Africa/Niamey

        * `Africa/Nouakchott` - Africa/Nouakchott

        * `Africa/Ouagadougou` - Africa/Ouagadougou

        * `Africa/Porto-Novo` - Africa/Porto-Novo

        * `Africa/Sao_Tome` - Africa/Sao_Tome

        * `Africa/Tripoli` - Africa/Tripoli

        * `Africa/Tunis` - Africa/Tunis

        * `Africa/Windhoek` - Africa/Windhoek

        * `America/Adak` - America/Adak

        * `America/Anchorage` - America/Anchorage

        * `America/Anguilla` - America/Anguilla

        * `America/Antigua` - America/Antigua

        * `America/Araguaina` - America/Araguaina

        * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires

        * `America/Argentina/Catamarca` - America/Argentina/Catamarca

        * `America/Argentina/Cordoba` - America/Argentina/Cordoba

        * `America/Argentina/Jujuy` - America/Argentina/Jujuy

        * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja

        * `America/Argentina/Mendoza` - America/Argentina/Mendoza

        * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos

        * `America/Argentina/Salta` - America/Argentina/Salta

        * `America/Argentina/San_Juan` - America/Argentina/San_Juan

        * `America/Argentina/San_Luis` - America/Argentina/San_Luis

        * `America/Argentina/Tucuman` - America/Argentina/Tucuman

        * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia

        * `America/Aruba` - America/Aruba

        * `America/Asuncion` - America/Asuncion

        * `America/Atikokan` - America/Atikokan

        * `America/Bahia` - America/Bahia

        * `America/Bahia_Banderas` - America/Bahia_Banderas

        * `America/Barbados` - America/Barbados

        * `America/Belem` - America/Belem

        * `America/Belize` - America/Belize

        * `America/Blanc-Sablon` - America/Blanc-Sablon

        * `America/Boa_Vista` - America/Boa_Vista

        * `America/Bogota` - America/Bogota

        * `America/Boise` - America/Boise

        * `America/Cambridge_Bay` - America/Cambridge_Bay

        * `America/Campo_Grande` - America/Campo_Grande

        * `America/Cancun` - America/Cancun

        * `America/Caracas` - America/Caracas

        * `America/Cayenne` - America/Cayenne

        * `America/Cayman` - America/Cayman

        * `America/Chicago` - America/Chicago

        * `America/Chihuahua` - America/Chihuahua

        * `America/Costa_Rica` - America/Costa_Rica

        * `America/Creston` - America/Creston

        * `America/Cuiaba` - America/Cuiaba

        * `America/Curacao` - America/Curacao

        * `America/Danmarkshavn` - America/Danmarkshavn

        * `America/Dawson` - America/Dawson

        * `America/Dawson_Creek` - America/Dawson_Creek

        * `America/Denver` - America/Denver

        * `America/Detroit` - America/Detroit

        * `America/Dominica` - America/Dominica

        * `America/Edmonton` - America/Edmonton

        * `America/Eirunepe` - America/Eirunepe

        * `America/El_Salvador` - America/El_Salvador

        * `America/Fort_Nelson` - America/Fort_Nelson

        * `America/Fortaleza` - America/Fortaleza

        * `America/Glace_Bay` - America/Glace_Bay

        * `America/Godthab` - America/Godthab

        * `America/Goose_Bay` - America/Goose_Bay

        * `America/Grand_Turk` - America/Grand_Turk

        * `America/Grenada` - America/Grenada

        * `America/Guadeloupe` - America/Guadeloupe

        * `America/Guatemala` - America/Guatemala

        * `America/Guayaquil` - America/Guayaquil

        * `America/Guyana` - America/Guyana

        * `America/Halifax` - America/Halifax

        * `America/Havana` - America/Havana

        * `America/Hermosillo` - America/Hermosillo

        * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis

        * `America/Indiana/Knox` - America/Indiana/Knox

        * `America/Indiana/Marengo` - America/Indiana/Marengo

        * `America/Indiana/Petersburg` - America/Indiana/Petersburg

        * `America/Indiana/Tell_City` - America/Indiana/Tell_City

        * `America/Indiana/Vevay` - America/Indiana/Vevay

        * `America/Indiana/Vincennes` - America/Indiana/Vincennes

        * `America/Indiana/Winamac` - America/Indiana/Winamac

        * `America/Inuvik` - America/Inuvik

        * `America/Iqaluit` - America/Iqaluit

        * `America/Jamaica` - America/Jamaica

        * `America/Juneau` - America/Juneau

        * `America/Kentucky/Louisville` - America/Kentucky/Louisville

        * `America/Kentucky/Monticello` - America/Kentucky/Monticello

        * `America/Kralendijk` - America/Kralendijk

        * `America/La_Paz` - America/La_Paz

        * `America/Lima` - America/Lima

        * `America/Los_Angeles` - America/Los_Angeles

        * `America/Lower_Princes` - America/Lower_Princes

        * `America/Maceio` - America/Maceio

        * `America/Managua` - America/Managua

        * `America/Manaus` - America/Manaus

        * `America/Marigot` - America/Marigot

        * `America/Martinique` - America/Martinique

        * `America/Matamoros` - America/Matamoros

        * `America/Mazatlan` - America/Mazatlan

        * `America/Menominee` - America/Menominee

        * `America/Merida` - America/Merida

        * `America/Metlakatla` - America/Metlakatla

        * `America/Mexico_City` - America/Mexico_City

        * `America/Miquelon` - America/Miquelon

        * `America/Moncton` - America/Moncton

        * `America/Monterrey` - America/Monterrey

        * `America/Montevideo` - America/Montevideo

        * `America/Montserrat` - America/Montserrat

        * `America/Nassau` - America/Nassau

        * `America/New_York` - America/New_York

        * `America/Nipigon` - America/Nipigon

        * `America/Nome` - America/Nome

        * `America/Noronha` - America/Noronha

        * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah

        * `America/North_Dakota/Center` - America/North_Dakota/Center

        * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem

        * `America/Ojinaga` - America/Ojinaga

        * `America/Panama` - America/Panama

        * `America/Pangnirtung` - America/Pangnirtung

        * `America/Paramaribo` - America/Paramaribo

        * `America/Phoenix` - America/Phoenix

        * `America/Port-au-Prince` - America/Port-au-Prince

        * `America/Port_of_Spain` - America/Port_of_Spain

        * `America/Porto_Velho` - America/Porto_Velho

        * `America/Puerto_Rico` - America/Puerto_Rico

        * `America/Punta_Arenas` - America/Punta_Arenas

        * `America/Rainy_River` - America/Rainy_River

        * `America/Rankin_Inlet` - America/Rankin_Inlet

        * `America/Recife` - America/Recife

        * `America/Regina` - America/Regina

        * `America/Resolute` - America/Resolute

        * `America/Rio_Branco` - America/Rio_Branco

        * `America/Santarem` - America/Santarem

        * `America/Santiago` - America/Santiago

        * `America/Santo_Domingo` - America/Santo_Domingo

        * `America/Sao_Paulo` - America/Sao_Paulo

        * `America/Scoresbysund` - America/Scoresbysund

        * `America/Sitka` - America/Sitka

        * `America/St_Barthelemy` - America/St_Barthelemy

        * `America/St_Johns` - America/St_Johns

        * `America/St_Kitts` - America/St_Kitts

        * `America/St_Lucia` - America/St_Lucia

        * `America/St_Thomas` - America/St_Thomas

        * `America/St_Vincent` - America/St_Vincent

        * `America/Swift_Current` - America/Swift_Current

        * `America/Tegucigalpa` - America/Tegucigalpa

        * `America/Thule` - America/Thule

        * `America/Thunder_Bay` - America/Thunder_Bay

        * `America/Tijuana` - America/Tijuana

        * `America/Toronto` - America/Toronto

        * `America/Tortola` - America/Tortola

        * `America/Vancouver` - America/Vancouver

        * `America/Whitehorse` - America/Whitehorse

        * `America/Winnipeg` - America/Winnipeg

        * `America/Yakutat` - America/Yakutat

        * `America/Yellowknife` - America/Yellowknife

        * `Antarctica/Casey` - Antarctica/Casey

        * `Antarctica/Davis` - Antarctica/Davis

        * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville

        * `Antarctica/Macquarie` - Antarctica/Macquarie

        * `Antarctica/Mawson` - Antarctica/Mawson

        * `Antarctica/McMurdo` - Antarctica/McMurdo

        * `Antarctica/Palmer` - Antarctica/Palmer

        * `Antarctica/Rothera` - Antarctica/Rothera

        * `Antarctica/Syowa` - Antarctica/Syowa

        * `Antarctica/Troll` - Antarctica/Troll

        * `Antarctica/Vostok` - Antarctica/Vostok

        * `Arctic/Longyearbyen` - Arctic/Longyearbyen

        * `Asia/Aden` - Asia/Aden

        * `Asia/Almaty` - Asia/Almaty

        * `Asia/Amman` - Asia/Amman

        * `Asia/Anadyr` - Asia/Anadyr

        * `Asia/Aqtau` - Asia/Aqtau

        * `Asia/Aqtobe` - Asia/Aqtobe

        * `Asia/Ashgabat` - Asia/Ashgabat

        * `Asia/Atyrau` - Asia/Atyrau

        * `Asia/Baghdad` - Asia/Baghdad

        * `Asia/Bahrain` - Asia/Bahrain

        * `Asia/Baku` - Asia/Baku

        * `Asia/Bangkok` - Asia/Bangkok

        * `Asia/Barnaul` - Asia/Barnaul

        * `Asia/Beirut` - Asia/Beirut

        * `Asia/Bishkek` - Asia/Bishkek

        * `Asia/Brunei` - Asia/Brunei

        * `Asia/Chita` - Asia/Chita

        * `Asia/Choibalsan` - Asia/Choibalsan

        * `Asia/Colombo` - Asia/Colombo

        * `Asia/Damascus` - Asia/Damascus

        * `Asia/Dhaka` - Asia/Dhaka

        * `Asia/Dili` - Asia/Dili

        * `Asia/Dubai` - Asia/Dubai

        * `Asia/Dushanbe` - Asia/Dushanbe

        * `Asia/Famagusta` - Asia/Famagusta

        * `Asia/Gaza` - Asia/Gaza

        * `Asia/Hebron` - Asia/Hebron

        * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh

        * `Asia/Hong_Kong` - Asia/Hong_Kong

        * `Asia/Hovd` - Asia/Hovd

        * `Asia/Irkutsk` - Asia/Irkutsk

        * `Asia/Jakarta` - Asia/Jakarta

        * `Asia/Jayapura` - Asia/Jayapura

        * `Asia/Jerusalem` - Asia/Jerusalem

        * `Asia/Kabul` - Asia/Kabul

        * `Asia/Kamchatka` - Asia/Kamchatka

        * `Asia/Karachi` - Asia/Karachi

        * `Asia/Kathmandu` - Asia/Kathmandu

        * `Asia/Khandyga` - Asia/Khandyga

        * `Asia/Kolkata` - Asia/Kolkata

        * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk

        * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur

        * `Asia/Kuching` - Asia/Kuching

        * `Asia/Kuwait` - Asia/Kuwait

        * `Asia/Macau` - Asia/Macau

        * `Asia/Magadan` - Asia/Magadan

        * `Asia/Makassar` - Asia/Makassar

        * `Asia/Manila` - Asia/Manila

        * `Asia/Muscat` - Asia/Muscat

        * `Asia/Nicosia` - Asia/Nicosia

        * `Asia/Novokuznetsk` - Asia/Novokuznetsk

        * `Asia/Novosibirsk` - Asia/Novosibirsk

        * `Asia/Omsk` - Asia/Omsk

        * `Asia/Oral` - Asia/Oral

        * `Asia/Phnom_Penh` - Asia/Phnom_Penh

        * `Asia/Pontianak` - Asia/Pontianak

        * `Asia/Pyongyang` - Asia/Pyongyang

        * `Asia/Qatar` - Asia/Qatar

        * `Asia/Qyzylorda` - Asia/Qyzylorda

        * `Asia/Riyadh` - Asia/Riyadh

        * `Asia/Sakhalin` - Asia/Sakhalin

        * `Asia/Samarkand` - Asia/Samarkand

        * `Asia/Seoul` - Asia/Seoul

        * `Asia/Shanghai` - Asia/Shanghai

        * `Asia/Singapore` - Asia/Singapore

        * `Asia/Srednekolymsk` - Asia/Srednekolymsk

        * `Asia/Taipei` - Asia/Taipei

        * `Asia/Tashkent` - Asia/Tashkent

        * `Asia/Tbilisi` - Asia/Tbilisi

        * `Asia/Tehran` - Asia/Tehran

        * `Asia/Thimphu` - Asia/Thimphu

        * `Asia/Tokyo` - Asia/Tokyo

        * `Asia/Tomsk` - Asia/Tomsk

        * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar

        * `Asia/Urumqi` - Asia/Urumqi

        * `Asia/Ust-Nera` - Asia/Ust-Nera

        * `Asia/Vientiane` - Asia/Vientiane

        * `Asia/Vladivostok` - Asia/Vladivostok

        * `Asia/Yakutsk` - Asia/Yakutsk

        * `Asia/Yangon` - Asia/Yangon

        * `Asia/Yekaterinburg` - Asia/Yekaterinburg

        * `Asia/Yerevan` - Asia/Yerevan

        * `Atlantic/Azores` - Atlantic/Azores

        * `Atlantic/Bermuda` - Atlantic/Bermuda

        * `Atlantic/Canary` - Atlantic/Canary

        * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde

        * `Atlantic/Faroe` - Atlantic/Faroe

        * `Atlantic/Madeira` - Atlantic/Madeira

        * `Atlantic/Reykjavik` - Atlantic/Reykjavik

        * `Atlantic/South_Georgia` - Atlantic/South_Georgia

        * `Atlantic/St_Helena` - Atlantic/St_Helena

        * `Atlantic/Stanley` - Atlantic/Stanley

        * `Australia/Adelaide` - Australia/Adelaide

        * `Australia/Brisbane` - Australia/Brisbane

        * `Australia/Broken_Hill` - Australia/Broken_Hill

        * `Australia/Currie` - Australia/Currie

        * `Australia/Darwin` - Australia/Darwin

        * `Australia/Eucla` - Australia/Eucla

        * `Australia/Hobart` - Australia/Hobart

        * `Australia/Lindeman` - Australia/Lindeman

        * `Australia/Lord_Howe` - Australia/Lord_Howe

        * `Australia/Melbourne` - Australia/Melbourne

        * `Australia/Perth` - Australia/Perth

        * `Australia/Sydney` - Australia/Sydney

        * `Canada/Atlantic` - Canada/Atlantic

        * `Canada/Central` - Canada/Central

        * `Canada/Eastern` - Canada/Eastern

        * `Canada/Mountain` - Canada/Mountain

        * `Canada/Newfoundland` - Canada/Newfoundland

        * `Canada/Pacific` - Canada/Pacific

        * `Europe/Amsterdam` - Europe/Amsterdam

        * `Europe/Andorra` - Europe/Andorra

        * `Europe/Astrakhan` - Europe/Astrakhan

        * `Europe/Athens` - Europe/Athens

        * `Europe/Belgrade` - Europe/Belgrade

        * `Europe/Berlin` - Europe/Berlin

        * `Europe/Bratislava` - Europe/Bratislava

        * `Europe/Brussels` - Europe/Brussels

        * `Europe/Bucharest` - Europe/Bucharest

        * `Europe/Budapest` - Europe/Budapest

        * `Europe/Busingen` - Europe/Busingen

        * `Europe/Chisinau` - Europe/Chisinau

        * `Europe/Copenhagen` - Europe/Copenhagen

        * `Europe/Dublin` - Europe/Dublin

        * `Europe/Gibraltar` - Europe/Gibraltar

        * `Europe/Guernsey` - Europe/Guernsey

        * `Europe/Helsinki` - Europe/Helsinki

        * `Europe/Isle_of_Man` - Europe/Isle_of_Man

        * `Europe/Istanbul` - Europe/Istanbul

        * `Europe/Jersey` - Europe/Jersey

        * `Europe/Kaliningrad` - Europe/Kaliningrad

        * `Europe/Kiev` - Europe/Kiev

        * `Europe/Kirov` - Europe/Kirov

        * `Europe/Lisbon` - Europe/Lisbon

        * `Europe/Ljubljana` - Europe/Ljubljana

        * `Europe/London` - Europe/London

        * `Europe/Luxembourg` - Europe/Luxembourg

        * `Europe/Madrid` - Europe/Madrid

        * `Europe/Malta` - Europe/Malta

        * `Europe/Mariehamn` - Europe/Mariehamn

        * `Europe/Minsk` - Europe/Minsk

        * `Europe/Monaco` - Europe/Monaco

        * `Europe/Moscow` - Europe/Moscow

        * `Europe/Oslo` - Europe/Oslo

        * `Europe/Paris` - Europe/Paris

        * `Europe/Podgorica` - Europe/Podgorica

        * `Europe/Prague` - Europe/Prague

        * `Europe/Riga` - Europe/Riga

        * `Europe/Rome` - Europe/Rome

        * `Europe/Samara` - Europe/Samara

        * `Europe/San_Marino` - Europe/San_Marino

        * `Europe/Sarajevo` - Europe/Sarajevo

        * `Europe/Saratov` - Europe/Saratov

        * `Europe/Simferopol` - Europe/Simferopol

        * `Europe/Skopje` - Europe/Skopje

        * `Europe/Sofia` - Europe/Sofia

        * `Europe/Stockholm` - Europe/Stockholm

        * `Europe/Tallinn` - Europe/Tallinn

        * `Europe/Tirane` - Europe/Tirane

        * `Europe/Ulyanovsk` - Europe/Ulyanovsk

        * `Europe/Uzhgorod` - Europe/Uzhgorod

        * `Europe/Vaduz` - Europe/Vaduz

        * `Europe/Vatican` - Europe/Vatican

        * `Europe/Vienna` - Europe/Vienna

        * `Europe/Vilnius` - Europe/Vilnius

        * `Europe/Volgograd` - Europe/Volgograd

        * `Europe/Warsaw` - Europe/Warsaw

        * `Europe/Zagreb` - Europe/Zagreb

        * `Europe/Zaporozhye` - Europe/Zaporozhye

        * `Europe/Zurich` - Europe/Zurich

        * `GMT` - GMT

        * `Indian/Antananarivo` - Indian/Antananarivo

        * `Indian/Chagos` - Indian/Chagos

        * `Indian/Christmas` - Indian/Christmas

        * `Indian/Cocos` - Indian/Cocos

        * `Indian/Comoro` - Indian/Comoro

        * `Indian/Kerguelen` - Indian/Kerguelen

        * `Indian/Mahe` - Indian/Mahe

        * `Indian/Maldives` - Indian/Maldives

        * `Indian/Mauritius` - Indian/Mauritius

        * `Indian/Mayotte` - Indian/Mayotte

        * `Indian/Reunion` - Indian/Reunion

        * `Pacific/Apia` - Pacific/Apia

        * `Pacific/Auckland` - Pacific/Auckland

        * `Pacific/Bougainville` - Pacific/Bougainville

        * `Pacific/Chatham` - Pacific/Chatham

        * `Pacific/Chuuk` - Pacific/Chuuk

        * `Pacific/Easter` - Pacific/Easter

        * `Pacific/Efate` - Pacific/Efate

        * `Pacific/Enderbury` - Pacific/Enderbury

        * `Pacific/Fakaofo` - Pacific/Fakaofo

        * `Pacific/Fiji` - Pacific/Fiji

        * `Pacific/Funafuti` - Pacific/Funafuti

        * `Pacific/Galapagos` - Pacific/Galapagos

        * `Pacific/Gambier` - Pacific/Gambier

        * `Pacific/Guadalcanal` - Pacific/Guadalcanal

        * `Pacific/Guam` - Pacific/Guam

        * `Pacific/Honolulu` - Pacific/Honolulu

        * `Pacific/Kiritimati` - Pacific/Kiritimati

        * `Pacific/Kosrae` - Pacific/Kosrae

        * `Pacific/Kwajalein` - Pacific/Kwajalein

        * `Pacific/Majuro` - Pacific/Majuro

        * `Pacific/Marquesas` - Pacific/Marquesas

        * `Pacific/Midway` - Pacific/Midway

        * `Pacific/Nauru` - Pacific/Nauru

        * `Pacific/Niue` - Pacific/Niue

        * `Pacific/Norfolk` - Pacific/Norfolk

        * `Pacific/Noumea` - Pacific/Noumea

        * `Pacific/Pago_Pago` - Pacific/Pago_Pago

        * `Pacific/Palau` - Pacific/Palau

        * `Pacific/Pitcairn` - Pacific/Pitcairn

        * `Pacific/Pohnpei` - Pacific/Pohnpei

        * `Pacific/Port_Moresby` - Pacific/Port_Moresby

        * `Pacific/Rarotonga` - Pacific/Rarotonga

        * `Pacific/Saipan` - Pacific/Saipan

        * `Pacific/Tahiti` - Pacific/Tahiti

        * `Pacific/Tarawa` - Pacific/Tarawa

        * `Pacific/Tongatapu` - Pacific/Tongatapu

        * `Pacific/Wake` - Pacific/Wake

        * `Pacific/Wallis` - Pacific/Wallis

        * `US/Alaska` - US/Alaska

        * `US/Arizona` - US/Arizona

        * `US/Central` - US/Central

        * `US/Eastern` - US/Eastern

        * `US/Hawaii` - US/Hawaii

        * `US/Mountain` - US/Mountain

        * `US/Pacific` - US/Pacific

        * `UTC` - UTC'
    LineItemCustomFieldRequest:
      type: object
      description: "Serializer used when custom fields are provided in a request. E.g JSON request with:\n\"custom_fields\": [\n    {\n    \"custom_field_name\": \"string\",\n    \"custom_field_value\": \"string\"\n    },\n    ...\n]"
      properties:
        custom_field_name:
          type: string
          minLength: 1
        custom_field_value:
          type: string
          minLength: 1
      required:
      - custom_field_name
      - custom_field_value
    RequisitionLineCreateRequest:
      type: object
      properties:
        item_name:
          type: string
          minLength: 1
          maxLength: 255
        vendor_name:
          type: string
          minLength: 1
        account_code:
          type: string
          minLength: 1
        unit_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
        quantity:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
        unit:
          type: string
          minLength: 1
          maxLength: 30
        currency_code:
          type: string
          minLength: 1
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/LineItemCustomFieldRequest'
      required:
      - account_code
      - currency_code
      - custom_fields
      - item_name
      - quantity
      - unit
      - unit_price
      - vendor_name
    BlankEnum:
      enum:
      - ''
    OrderRead:
      type: object
      properties:
        num:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
        branch:
          $ref: '#/components/schemas/Branch'
        user:
          $ref: '#/components/schemas/UserSummary'
        department:
          $ref: '#/components/schemas/DepartmentSummary'
        currency:
          allOf:
          - $ref: '#/components/schemas/CurrencySummary'
          readOnly: true
        total_cost_in_base_currency:
          type: number
          format: float
          readOnly: true
        logs:
          type: array
          items:
            $ref: '#/components/schemas/MasterLogger'
        item_count:
          type: integer
          readOnly: true
        ip_address:
          type: string
          nullable: true
        date:
          type: string
          format: date-time
          readOnly: true
        description:
          type: string
          nullable: true
        dateRequired:
          type: string
          format: date-time
        dateModified:
          type: string
          format: date-time
          readOnly: true
        lineCount:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        purchasedCount:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        totalPrice:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          nullable: true
        status:
          allOf:
          - $ref: '#/components/schemas/OrderStatusEnum'
          minimum: -2147483648
          maximum: 2147483647
        next_approver:
          allOf:
          - $ref: '#/components/schemas/UserSummary'
          readOnly: true
        next_approvers:
          type: array
          items:
            $ref: '#/components/schemas/UserSummary'
        approval_delegatee:
          type: integer
          nullable: true
        punchout_group:
          allOf:
          - $ref: '#/components/schemas/PunchOutReadDocs'
          nullable: true
          readOnly: true
          type: object
        punchout_shipping_address:
          allOf:
          - $ref: '#/components/schemas/AddressDocs'
          nullable: true
          readOnly: true
          type: object
        punchout_items_rejected:
          type: boolean
          readOnly: true
        punchout_supplier_name:
          type: string
          readOnly: true
          nullable: true
        punchout_supplier_icon:
          type: string
          readOnly: true
          nullable: true
        punchout_vendor_reference:
          type: integer
          nullable: true
          readOnly: true
        punchout_is_retriable:
          type: boolean
          readOnly: true
        punchout_order_purchase_order_id:
          type: integer
          readOnly: true
          nullable: true
        has_blanket_order_items:
          type: boolean
          readOnly: true
        approval_workflow:
          allOf:
          - $ref: '#/components/schemas/ApprovalWorkflow'
          readOnly: true
        denial_reason:
          nullable: true
          minimum: 0
          maximum: 4294967295
          oneOf:
          - $ref: '#/components/schemas/DenialReasonEnum'
          - $ref: '#/components/schemas/NullEnum'
          type: integer
        denial_comment:
          type: string
          nullable: true
          maxLength: 300
      required:
      - branch
      - dateRequired
      - department
      - logs
      - next_approvers
      - user
      - uuid
    OrderItem:
      type: object
      properties:
        PO:
          type: array
          items:
            type: integer
            title: PO
        PO_line_num:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        account:
          type: integer
        accountCode:
          type: string
          maxLength: 100
        active:
          type: boolean
        approved_currency_rate:
          type: string
          format: decimal
          pattern: ^-?\d{0,9}(?:\.\d{0,6})?$
          nullable: true
        approved_datetime:
          type: string
          format: date-time
          nullable: true
        approved_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
          nullable: true
        approved_quantity:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
          nullable: true
        approved_shipping_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
          nullable: true
        approved_tax_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
          nullable: true
        attachments:
          type: string
        catalog_item:
          type: integer
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        currency:
          type: integer
        dateInvoiced:
          type: string
          format: date-time
          nullable: true
        external_id:
          type: string
          description: External id of the order item
          maxLength: 100
        hot:
          type: boolean
        id:
          type: integer
          readOnly: true
        inventoryItem:
          type: integer
          nullable: true
        is_active:
          type: boolean
        item_attachments:
          type: array
          items:
            type: integer
        last_changed_by:
          type: integer
          nullable: true
          title: Last changed by user
        last_modified:
          type: string
          format: date-time
          readOnly: true
        lineComment:
          type: string
          nullable: true
        name:
          type: string
          maxLength: 255
        num:
          type: string
          maxLength: 50
        orderNum:
          type: integer
          nullable: true
        order_number:
          type: integer
          readOnly: true
          nullable: true
        po_note:
          type: string
          title: Comment
        po_version:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        pref_vendor:
          type: integer
        price:
          type: string
          format: decimal
          pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
        purchase_order:
          type: integer
          title: Procurify PO Number
          nullable: true
        purchaser:
          type: integer
          nullable: true
        quantity:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
        receivedFailQty:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
          title: Received Fail Quantity
        receivedPassQty:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
          title: Received Pass Quantity
        shipping_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
          nullable: true
        sku:
          type: string
          maxLength: 100
        status:
          nullable: true
          minimum: -2147483648
          maximum: 2147483647
          oneOf:
          - $ref: '#/components/schemas/OrderItemStatusEnum'
          - $ref: '#/components/schemas/NullEnum'
          type: integer
        tax_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
          nullable: true
        total_cost:
          type: string
          format: decimal
          pattern: ^-?\d{0,16}(?:\.\d{0,2})?$
        unit:
          type: string
          maxLength: 30
        updated_at:
          type: string
          format: date-time
          readOnly: true
        vendor:
          type: string
          nullable: true
          maxLength: 100
        receive_method:
          allOf:
          - $ref: '#/components/schemas/ReceiveMethodEnum'
          minimum: 0
          maximum: 65535
        type:
          allOf:
          - $ref: '#/components/schemas/OrderItemTypeEnum'
          minimum: 0
          maximum: 65535
        blanket:
          allOf:
          - $ref: '#/components/schemas/BlanketOrderItemRead'
          readOnly: true
      required:
      - account
      - approved_datetime
      - currency
      - name
      - num
      - pref_vendor
      - price
      - quantity
      - unit
    AddressDocs:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
      - id
      - name
    LanguageEnum:
      enum:
      - 1
      type: integer
      description: '* `1` - English'
    SetupStageEnum:
      enum:
      - COMP
      - DEPT
      - USER
      - COA
      - BDGT
      - APPR
      - FIN
      type: string
      description: '* `COMP` - Company

        * `DEPT` - Department

        * `USER` - User

        * `COA` - Chart_of_Accounts

        * `BDGT` - Budget_Control

        * `APPR` - Approver

        * `FIN` - Finished'
    PunchOutReadDocs:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
      - id
      - name
    OrderStatusEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
      description: '* `0` - Pending

        * `1` - Approved

        * `2` - Denied

        * `3` - Purchased

        * `4` - Cancelled

        * `5` - Received

        * `6` - Draft'
    ActionEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      type: integer
      description: '* `0` - Request

        * `1` - FinalApproval

        * `2` - ApprovalDenied

        * `3` - ApproveAndPassOn

        * `4` - Purchase

        * `5` - RejectLineItems

        * `6` - UpdateOnReceive

        * `7` - MarkOrderReceived

        * `8` - ClosePO

        * `9` - UnmarkOrderReceived

        * `10` - OpenPO

        * `11` - RequestLineItem

        * `12` - UndoReceiveLog

        * `13` - CancelPO

        * `14` - StockLineItem

        * `15` - TransactionApproved

        * `16` - TransactionDenied

        * `17` - TransactionPartiallyDenied

        * `18` - TransactionAllocation

        * `19` - OrderPurchased

        * `20` - RecordPO'
    SimpleUserProfile:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        firstName:
          type: string
          maxLength: 100
        lastName:
          type: string
          maxLength: 100
        email:
          type: string
          format: email
          maxLength: 254
        role:
          allOf:
          - $ref: '#/components/schemas/MinimalRoleRead'
          readOnly: true
        profile_image:
          type: string
          nullable: true
      required:
      - email
    SimpleDepartment:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 150
        location:
          $ref: '#/components/schemas/SimpleLocation'
      required:
      - location
      - name
    ApprovalDelegationRead:
      type: object
      properties:
        approval_delegatee:
          $ref: '#/components/schemas/UserProfileRead'
        expected_return_date:
          type: string
          format: date
          nullable: true
        delegator:
          $ref: '#/components/schemas/SimpleUserProfile'
        setter:
          $ref: '#/components/schemas/SimpleUserProfile'
      required:
      - approval_delegatee
      - delegator
      - setter
    ApprovalDelegateeDocs:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        department:
          type: integer
          nullable: true
        firstName:
          type: string
          maxLength: 100
        lastName:
          type: string
          maxLength: 100
        email:
          type: string
          format: email
          maxLength: 254
      required:
      - email
    Branch:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        external_id:
          type: string
          nullable: true
          description: External id
          maxLength: 100
        name:
          type: string
          maxLength: 150
        url:
          type: string
          format: uri
          nullable: true
          maxLength: 200
        logo:
          type: string
        language:
          allOf:
          - $ref: '#/components/schemas/LanguageEnum'
          minimum: -2147483648
          maximum: 2147483647
        multipleLocations:
          type: boolean
        locationTimezone:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/LocationTimezoneEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
          type: integer
        userLimit:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
        budgetOvertureToggle:
          type: boolean
        purchase_filtering:
          type: boolean
        catalog_permission:
          type: boolean
        separate_expense_approval:
          type: boolean
        standalone_travel_approval:
          type: boolean
        phoneOne:
          type: string
          maxLength: 20
        phoneTwo:
          type: string
          nullable: true
          maxLength: 20
        fax:
          type: string
          nullable: true
          maxLength: 20
        email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        fiscalYearEndDay:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
        fiscalYearEndMonth:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
        beginDate:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        ported:
          type: boolean
        port_date:
          type: string
          format: date-time
          nullable: true
        active:
          type: boolean
        activated:
          type: boolean
        setup_stage:
          $ref: '#/components/schemas/SetupStageEnum'
        localCurrency:
          type: integer
        contactPerson:
          type: integer
          nullable: true
        buyerAddress:
          type: integer
          nullable: true
        shippingAddress:
          type: integer
          nullable: true
      required:
      - localCurrency
      - name
      - phoneOne
    RequisitionCreateRequest:
      type: object
      properties:
        required_date:
          type: string
          format: date
        location_name:
          type: string
          minLength: 1
        department_name:
          type: string
          minLength: 1
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/RequisitionLineCreateRequest'
      required:
      - department_name
      - line_items
      - location_name
      - required_date
    ApprovalWorkflow:
      type: object
      properties:
        is_complete:
          type: boolean
        updated_at:
          type: string
          format: date-time
        can_self_approve:
          type: boolean
        can_peer_review:
          type: boolean
        current_step:
          allOf:
          - $ref: '#/components/schemas/ApprovalWorkflowCurrentStep'
          nullable: true
          type: object
        next_step:
          allOf:
          - $ref: '#/components/schemas/ApprovalWorkflowNextStep'
          nullable: true
          type: object
      required:
      - can_peer_review
      - can_self_approve
      - current_step
      - is_complete
      - next_step
      - updated_at
    ApprovalDelegatee:
      type: object
      properties:
        id:
          type: integer
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        profile_image:
          type: string
          nullable: true
      required:
      - email
      - firstName
      - id
      - lastName
    ApprovalWorkflowNextStep:
      type: object
      properties:
        status:
          type: integer
        step_number:
          type: integer
        group_id:
          type: integer
        group_name:
          type: string
        options:
          type: array
          items:
            type: object
            additionalProperties: {}
      required:
      - group_id
      - group_name
      - options
      - status
      - step_number
    NullEnum:
      enum:
      - null
    OrderItemStatusEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      type: integer
      description: '* `0` - Purchase Pending

        * `1` - Purchaser In-Use

        * `2` - Receive Pending

        * `3` - Received

        * `4` - Rejected for Purchase

        * `5` - Partial Received

        * `6` - Fulfilled

        * `7` - Approval Denied

        * `8` - Request Draft'
    ReceiveMethodEnum:
      enum:
      - 0
      - 1
      type: integer
      description: '* `0` - Quantity

        * `1` - Currency amount'
    DepartmentSummary:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        branch:
          $ref: '#/components/schemas/BranchSummary'
        external_id:
          type: string
          nullable: true
          description: External id
          maxLength: 100
        name:
          type: string
          maxLength: 150
        punchout_email:
          type: string
          format: email
          nullable: true
          description: PunchOut Email
          maxLength: 254
        active:
          type: boolean
      required:
      - branch
      - name
    MinimalRoleRead:
      type: object
      properties:
        name:
          type: string
          maxLength: 150
        type:
          type: integer
      required:
      - name
      - type
    DenialReasonEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
      description: '* `1` - Other

        * `2` - Over budget

        * `3` - Unapproved vendor

        * `4` - Duplicate request

        * `5` - Policy violation

        * `6` - Incorrect specs

        * `7` - Per request

        * `8` - Missing information

        * `9` - Incorrect timing

        * `10` - Process not followed'
    BlanketOrderItemRead:
      type: object
      properties:
        price:
          type: string
          format: decimal
          pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
        quantity:
          type: number
          format: double
          nullable: true
          readOnly: true
        amount:
          type: number
          format: double
          nullable: true
          readOnly: true
      required:
      - price
    ApprovalWorkflowApprover:
      type: object
      properties:
        id:
          type: integer
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        profile_image:
          type: string
          nullable: true
        approval_delegatee:
          allOf:
          - $ref: '#/components/schemas/ApprovalDelegatee'
          nullable: true
          type: object
      required:
      - email
      - firstName
      - id
      - lastName
    RequisitionRead:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
    SimpleLocation:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 150
        headquarter:
          type: boolean
          readOnly: true
      required:
      - name
    CurrencySummary:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 10
        rate:
          type: string
          format: decimal
          pattern: ^-?\d{0,9}(?:\.\d{0,6})?$
        base:
          type: boolean
      required:
      - name
      - rate
    MasterLogger:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        user:
          $ref: '#/components/schemas/UserSummary'
        next_approver:
          $ref: '#/components/schemas/UserSummary'
        next_approvers:
          type: array
          items:
            type: integer
        nextApprover:
          $ref: '#/components/schemas/UserSummary'
        approval_delegation:
          allOf:
          - $ref: '#/components/schemas/ApprovalDelegationRead'
          nullable: true
          type: object
        dateTime:
          type: string
          format: date-time
          readOnly: true
        action:
          nullable: true
          minimum: -2147483648
          maximum: 2147483647
          oneOf:
          - $ref: '#/components/schemas/ActionEnum'
          - $ref: '#/components/schemas/NullEnum'
          type: integer
        line_qty_pass:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
          nullable: true
        line_qty_fail:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
          nullable: true
        order:
          type: integer
          nullable: true
        lineItem:
          type: integer
          nullable: true
        PO:
          type: integer
          title: Procurify PO Number
          nullable: true
        inventoryItem:
          type: integer
          nullable: true
        stocking_parent:
          type: integer
          nullable: true
      required:
      - approval_delegation
      - nextApprover
      - next_approver
      - user
    UserSummary:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        department:
          $ref: '#/components/schemas/DepartmentSummary'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        firstName:
          type: string
          maxLength: 100
        lastName:
          type: string
          maxLength: 100
        email:
          type: string
          format: email
          maxLength: 254
        position:
          type: string
          nullable: true
          maxLength: 100
        phone:
          type: string
          nullable: true
          maxLength: 30
        address:
          type: string
          nullable: true
        notifications:
          type: boolean
        is_active:
          type: boolean
        mobile:
          type: boolean
        profile_image:
          type: string
          nullable: true
        slack_user_id:
          type: string
          maxLength: 50
        is_sso_enabled:
          type: boolean
        last_changed_by:
          type: integer
          nullable: true
          title: Last changed by user
        user:
          type: integer
        approval_delegatee:
          allOf:
          - $ref: '#/components/schemas/ApprovalDelegateeDocs'
          nullable: true
          readOnly: true
          type: object
        expected_return_date:
          type: string
          format: date
          readOnly: true
      required:
      - department
      - email
      - user
  securitySchemes:
    BasicAuthentication:
      type: http
      scheme: basic
    M2MAuthentication:
      type: http
      scheme: bearer
      bearerFormat: JWT
    RemoteAuthentication:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://<your-domain>.procurify.com/oauth/authorize
          tokenUrl: https://<your-domain>.procurify.com/oauth/token
          scopes: {}
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid