openapi: 3.0.3 info: title: Procurify API Documentation 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. version: '' x-api-status-urls: false servers: - description: Your Procurify domain url: https://{user_domain}.procurify.com variables: user_domain: description: Your procurify domain default: your-domain tags: - name: ap - name: purchase-orders - name: users - name: vendors - name: catalog - name: locations - name: departments - name: account-codes - name: requisitions - name: permissions - name: custom-fields - name: oauth - name: accounts - name: currencies - name: order-items paths: /oauth/token: post: servers: - description: Authenticate with oauth url: https://.procurify.com tags: - oauth summary: Authenticate with OAuth operationId: Oauth_tokenRequest security: [] description: >- Getting access to Procurify API involves the following three steps: 1. Request credentials for your Procurify account. 2. Request access token using your credentials. 3. Use access token to access Procurify API resources. #### Request credentials for your Procurify account. The first step is to request credentials from Procurify. Your role must have access to manage integrations settings in order to request API credentials. You can request API credentials by going to go: 1. Settings in the left navigation bar. 2. Integrations in the Tools section. 3. View button beside API item This page will allow you to enter an optional description of the application you are developing with the Procurify API and once you are ready, click on “Create Application”. On the next screen, you will be presented with a Client ID and a Client Secret. You will need to copy and save these credentials securely. Please note that the Client Secret is only presented once. #### Request access token using your credentials. Once you have the client credentials, you will need to request an access token using these credentials that can be used as a bearer token when making a request to Procurify API. You will need the following information to request an access token: |Info|Value| --- | --- |Token URL:|https://<your-domain>.procurify.com/oauth/token| |Client ID:|*From the previous step*| |Client Secret:|*From the previous step*| |Audience:|https://api.procurify.com/| |Grant Type:|client_credentials| Once you have the access token, you will need to cache it until it expires (24 hrs). Please let Procurify support know if you would like help with this. An example request and response using cURL (replace client id and client secret) $ curl -H "content-type: application/json" -X POST \ -d '{"client_id": "~your_client_id~", \ "client_secret": "~your_client_secret~", \ "audience": "https://api.procurify.com/", \ "grant_type": "client_credentials"}' \ https://.procurify.com/oauth/token {"access_token": "~your-access-token~", "scope": "urn:procurify-api:domain:~your_domain~ urn:procurify-api:email:~your_email~", "expires_in": 86400, "token_type": "Bearer"} #### Use access token to access Procurify API resources. Once you have the access token, you can make requests to Procurify API resources. You will need to set the following headers when making the request. |Key|Value| --- | --- |Authorization:|Bearer *access_token from previous step*| |X-Procurify-Client:|api| An example request and response using cURL (replace access token and your procurify domain) $ curl -H "Authorization: Bearer ~access_token~" \ -H "X-Procurify-Client: api" \ https://.procurify.com/api/v3/vendors/ {"data":[{"id":1,"name":"OTHER","active":true,"addressLineOne":"OTHER"...} parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/OauthTokenRequestRequest' example: client_id: ~your_client_id~ client_secret: ~your_client_secret~ audience: https://api.procurify.com/ grant_type: client_credentials responses: '200': description: Successful authentication content: application/json: schema: $ref: '#/components/schemas/OauthTokenRequestResponse' example: access_token: ~your-access-token~ scope: >- urn:procurify-api:domain:~your_domain~ urn:procurify-api:email:~your_email~ expires_in: 86400 token_type: Bearer /api/v2/ap/bills/{id}: get: tags: - ap summary: Get Bills by ID operationId: Ap_billsGetById security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: ' ' parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string pattern: ^[0-9a-f]+$ required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BillMetadataBillRead' text/csv: schema: $ref: '#/components/schemas/BillMetadataBillRead' /api/v2/ap/company-payment-methods: get: tags: - ap summary: Get list of Company Payment Methods operationId: Ap_companyPaymentMethodsList security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: > **Payment Method Types:** | Payment Method | Type | |----------------|-----------| | OTHER | 0 | | CHECK | 1 | | CHEQUE | 1 | | ACH | 2 | | EFT | 3 | | WIRE | 4 | **The context of 'data' field varies based on different Payment Method type:** | Payment Method | 'data' field structure | |----------------|------------------------| | OTHER | ```{"description": }``` | | CHECK/CHEQUE | ```{"payable_to": }``` | | ACH | ```{"routing_number": , "account_number": , "company_name": }``` | parameters: - in: query name: currency schema: type: integer - in: query name: format schema: type: string enum: - csv - json - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string - in: query name: type schema: title: Payment Method type: integer enum: - 0 - 1 - 2 - 3 - 4 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedCompanyPaymentMethodReadList' examples: CompanyPaymentMethods: summary: Company Payment Methods value: data: - id: 1 name: Bank Account type: 0 data: description: Bank Account description currency: description: '' id: 3 name: USD rate: '1.000000' base: true active: true gl_code: '9000' metadata: pagination: count: 9 num_pages: 1 current_page: 1 page_size: 10 next: null previous: null text/csv: schema: $ref: '#/components/schemas/PaginatedCompanyPaymentMethodReadList' post: tags: - ap summary: Create Company Payment Method operationId: Ap_createCompanyPaymentMethod security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: > **Payment Method Types:** | Payment Method | Type | |----------------|-----------| | OTHER | 0 | | CHECK | 1 | | CHEQUE | 1 | | ACH | 2 | | EFT | 3 | | WIRE | 4 | **The context of 'data' field varies based on different Payment Method type:** | Payment Method | 'data' field structure | |----------------|------------------------| | OTHER | ```{"description": }``` | | CHECK/CHEQUE | ```{"payable_to": }``` | | ACH | ```{"routing_number": , "account_number": , "company_name": }``` | parameters: - in: query name: format schema: type: string enum: - csv - json requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyPaymentMethodRequest' examples: CompanyPaymentMethodPayloadExample: summary: Company Payment Method Payload Example value: name: Bank Account type: 0 data: description: Bank Account description gl_code: '9000' currency: 3 application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CompanyPaymentMethodRequest' '': schema: $ref: '#/components/schemas/CompanyPaymentMethodRequest' examples: CompanyPaymentMethodPayloadExample: summary: Company Payment Method Payload Example value: name: Bank Account type: 0 data: description: Bank Account description gl_code: '9000' currency: 3 application/xml: schema: $ref: '#/components/schemas/CompanyPaymentMethodRequest' multipart/form-data: schema: $ref: '#/components/schemas/CompanyPaymentMethodRequest' required: true responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CompanyPaymentMethod' examples: CompanyPaymentMethodResponseExample: summary: Company Payment Method Response Example value: id: 1 name: Bank Account type: 0 data: description: Bank Account description currency: description: '' id: 3 name: USD rate: '1.000000' base: true active: true gl_code: '9000' text/csv: schema: $ref: '#/components/schemas/CompanyPaymentMethod' /api/v2/ap/items: get: tags: - ap summary: Get Unbilled/Billed Items operationId: Ap_itemsGet security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: ' ' parameters: - in: query name: bill schema: type: integer - in: query name: bill_uuid schema: type: string format: uuid - in: query name: billed schema: type: boolean - in: query name: budget schema: type: integer - in: query name: created_at_0 schema: type: string format: date - in: query name: created_at_1 schema: type: string format: date - in: query name: department schema: type: number - in: query name: exclude schema: type: string - in: query name: format schema: type: string enum: - csv - json - in: query name: location schema: type: number - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - in: query name: received_on_0 schema: type: string format: date - in: query name: received_on_1 schema: type: string format: date - in: query name: reimburse schema: type: boolean - in: query name: requester schema: type: number - description: A search term. name: search required: false in: query schema: type: string - in: query name: vendor schema: type: integer responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ItemMetadataItemRead' text/csv: schema: $ref: '#/components/schemas/ItemMetadataItemRead' /api/v2/ap/payments: get: tags: - ap summary: Get Payments operationId: Ap_getPayments security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: approver schema: type: string - in: query name: currency schema: type: integer - in: query name: format schema: type: string enum: - csv - json - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - in: query name: payment_date_0 schema: type: string format: date - in: query name: payment_date_1 schema: type: string format: date - in: query name: payment_method__type schema: title: Payment Method type: integer enum: - 0 - 1 - 2 - 3 - 4 - description: A search term. name: search required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaymentMetadataPaymentListRead' text/csv: schema: $ref: '#/components/schemas/PaymentMetadataPaymentListRead' /api/v2/ap/payments/{id}/approver-choices: get: tags: - ap summary: Get Approver Choices operationId: Ap_paymentsApproverChoicesRetrieve security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this payment. in: path name: id schema: type: integer required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ApproverChoicesMetadataApproverReadDocs' text/csv: schema: $ref: '#/components/schemas/ApproverChoicesMetadataApproverReadDocs' /api/v2/ap/vendor-payment-methods: get: tags: - ap summary: Get list of Vendor Payment Methods operationId: Ap_vendorPaymentMethodsList security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: > **Payment Method Types:** | Payment Method | Type | |----------------|-----------| | OTHER | 0 | | CHECK | 1 | | CHEQUE | 1 | | ACH | 2 | | EFT | 3 | | WIRE | 4 | **The context of 'data' field varies based on different Payment Method type:** | Payment Method | 'data' field structure | |----------------|------------------------| | OTHER | ```{"description": }``` | | CHECK/CHEQUE | ```{"payable_to": }``` | | ACH | ```{"routing_number": , "account_number": , "company_name": }``` | parameters: - in: query name: currency schema: type: integer - in: query name: format schema: type: string enum: - csv - json - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string - in: query name: type schema: title: Payment Method type: integer enum: - 0 - 1 - 2 - 3 - 4 - in: query name: vendor schema: type: integer responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedVendorPaymentMethodReadList' examples: ListVendorPaymentMethodsResponseExample: summary: List Vendor Payment Methods Response Example value: data: - id: 1 vendor: 10 name: Technology Inc ACH 98G395E type: 2 data: company_name: ABC Technology Inc account_number: '****0021' routing_number: '****7892' currency: description: '' id: 3 name: USD rate: '1.000000' base: true active: true - id: 2 vendor: 20 name: Check - Reimbursable type: 1 data: payable_to: Frank Borman currency: description: '' id: 1 name: CAD rate: '0.769231' base: false active: true metadata: pagination: count: 25 num_pages: 3 current_page: 1 page_size: 10 next: >- https://antonio.dev.procurify.xyz/api/v2/ap/vendor-payment-methods/?page=2 previous: null text/csv: schema: $ref: '#/components/schemas/PaginatedVendorPaymentMethodReadList' post: tags: - ap summary: Create Vendor Payment Method operationId: Ap_createVendorPaymentMethod security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: > **Payment Method Types:** | Payment Method | Type | |----------------|-----------| | OTHER | 0 | | CHECK | 1 | | CHEQUE | 1 | | ACH | 2 | | EFT | 3 | | WIRE | 4 | **The context of 'data' field varies based on different Payment Method type:** | Payment Method | 'data' field structure | |----------------|------------------------| | OTHER | ```{"description": }``` | | CHECK/CHEQUE | ```{"payable_to": }``` | | ACH | ```{"routing_number": , "account_number": , "company_name": }``` | parameters: - in: query name: format schema: type: string enum: - csv - json requestBody: content: application/json: schema: $ref: '#/components/schemas/VendorPaymentMethodRequest' examples: VendorPaymentMethodPayloadExample: summary: Vendor Payment Method Payload Example value: vendor: 10 name: Technology Inc ACH 98G395E type: 2 data: company_name: ABC Technology Inc account_number: '****0021' routing_number: '****7892' currency: 3 application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VendorPaymentMethodRequest' '': schema: $ref: '#/components/schemas/VendorPaymentMethodRequest' examples: VendorPaymentMethodPayloadExample: summary: Vendor Payment Method Payload Example value: vendor: 10 name: Technology Inc ACH 98G395E type: 2 data: company_name: ABC Technology Inc account_number: '****0021' routing_number: '****7892' currency: 3 application/xml: schema: $ref: '#/components/schemas/VendorPaymentMethodRequest' multipart/form-data: schema: $ref: '#/components/schemas/VendorPaymentMethodRequest' required: true responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/VendorPaymentMethod' examples: VendorPaymentMethodResponseExample: summary: Vendor Payment Method Response Example value: id: 1 vendor: 10 name: Technology Inc ACH 98G395E type: 2 data: company_name: ABC Technology Inc account_number: '****0021' routing_number: '****7892' currency: description: '' id: 3 name: USD rate: '1.000000' base: true active: true text/csv: schema: $ref: '#/components/schemas/VendorPaymentMethod' /api/v2/currencies: get: tags: - currencies summary: Get Active/Inactive Currencies operationId: currencies_list security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: active schema: type: boolean - in: query name: base schema: type: boolean - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - csv - json - in: query name: name schema: type: string - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - in: query name: rate schema: type: number - description: A search term. name: search required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedCurrencyList' text/csv: schema: $ref: '#/components/schemas/PaginatedCurrencyList' /api/v2/global/order_items: get: tags: - requisitions summary: Get All Order Items operationId: Requisitions_getAllOrderItems security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] 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. | parameters: - in: query name: account schema: type: integer - description: Account Code in: query name: account_code schema: type: integer - in: query name: active schema: type: boolean - description: Approved Date 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 - 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 - description: Location in: query name: branch schema: type: integer - in: query name: catalog schema: type: boolean - description: A comma-separated list of integers. in: query name: catalog_item schema: type: string - in: query name: currency schema: type: integer - description: Department in: query name: department schema: type: integer - description: A comma-separated list of integers. in: query name: departments schema: type: string - description: A comma-separated list of integers. in: query name: exclude schema: type: string - 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 - description: Last Modified Date 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 - in: query name: lineComment schema: type: string - description: Location in: query name: location schema: type: integer - description: A comma-separated list of integers. in: query name: locations schema: type: string - 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: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: Order Created Date 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: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: Purchased Date 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 Vendor in: query name: po_vendor schema: type: integer - in: query name: pref_vendor schema: type: integer - in: query name: price schema: type: number - in: query name: purchase_agreement schema: type: number - description: Purchased Date 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 - 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 - description: Requester in: query name: requester schema: type: integer - description: A search term. name: search required: false in: query 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 - in: query name: type schema: type: integer enum: - 0 - 1 - 2 - in: query name: unit schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedOrderItemList' text/csv: schema: $ref: '#/components/schemas/PaginatedOrderItemList' /api/v2/global/orders: get: tags: - requisitions summary: Get All Orders operationId: Requisitions_getAllOrders security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: |- **Order Status Codes** | Order Type | Code | |---------------------|-----------| | PENDING | 0 | | APPROVED | 1 | | REJECTED | 2 | | PURCHASED | 3 | | CANCELLED (legacy) | 4 | | RECEIVED | 5 | | DRAFT | 6 | parameters: - in: query name: branch schema: type: integer - in: query name: dateRequired schema: type: string format: date-time - description: Date in: query name: date_0 schema: type: string format: date - description: Date in: query name: date_1 schema: type: string format: 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 - description: Last Modified Date 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: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: Date Required 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: A search term. name: search required: false in: query schema: type: string - in: query name: status schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - in: query name: totalPrice schema: type: number responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedOrderReadList' text/csv: schema: $ref: '#/components/schemas/PaginatedOrderReadList' /api/v2/locations: get: tags: - locations summary: Get Locations operationId: locations_list security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: active schema: type: boolean - in: query name: format schema: type: string enum: - csv - json - in: query name: headquarter schema: type: boolean - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedLocationViewSerializerListList' text/csv: schema: $ref: '#/components/schemas/PaginatedLocationViewSerializerListList' post: tags: - locations summary: Create New Location operationId: locations_create security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: >- Create New Location. Note: only users with superuser permission can create locations. parameters: - in: query name: format schema: type: string enum: - csv - json requestBody: content: application/json: schema: $ref: '#/components/schemas/LocationCreateUpsertRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LocationCreateUpsertRequest' '': schema: $ref: '#/components/schemas/LocationCreateUpsertRequest' application/xml: schema: $ref: '#/components/schemas/LocationCreateUpsertRequest' multipart/form-data: schema: $ref: '#/components/schemas/LocationCreateUpsertRequest' required: true responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/LocationViewSerializerSingleCreate' text/csv: schema: $ref: '#/components/schemas/LocationViewSerializerSingleCreate' /api/v2/locations/{id}: get: tags: - locations summary: Get Location by ID operationId: locations_retrieve security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/LocationViewSerializerSingleRetrieve' text/csv: schema: $ref: '#/components/schemas/LocationViewSerializerSingleRetrieve' /api/v2/purchase_order/revise/{procurify_PO}: put: tags: - purchase-orders summary: Revise a Purchase Order operationId: Purchaseorders_reviseProcurifyPO security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: >- Deprecated method for revising a purchase order. Pending removable after November 16, 2023. Use `PUT` on `/api/v3/purchase-orders/{id}` instead. parameters: - description: >- Mechanism to check for duplicate custom PO number. If there is a duplicate, API will fail unless this query param is set to True. in: query name: confirm_duplicate_external_po_number schema: type: string enum: - 'False' - 'True' default: 'False' - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this po. in: path name: procurify_PO schema: title: Procurify PO Number type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' '': schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' application/xml: schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderDetailSerializerSingle' text/csv: schema: $ref: '#/components/schemas/PurchaseOrderDetailSerializerSingle' deprecated: true /api/v2/purchase_orders/{id}: get: tags: - purchase-orders summary: Get Purchase Order by ID (with items) operationId: Purchaseorders_getByIdWithItems security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: |- **Purchase Order State Codes** | Order Type | Code | |---------------------|-----------| | PURCHASED | 0 | | CANCELLED | 1 | | (legacy code) | 2 | | CLOSED | 3 | | PAID | 4 | | REOPENED | 5 | parameters: - in: query name: format schema: type: string enum: - csv - json - description: Procurify PO or UUID in: path name: id schema: type: string required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ApiNestedEditDeletePurchaseOrderDetail' text/csv: schema: $ref: '#/components/schemas/ApiNestedEditDeletePurchaseOrderDetail' /api/v2/purchase_orders/{role}/{status}: get: tags: - purchase-orders summary: Get Purchase Orders by Role & Status operationId: Purchaseorders_getByRoleAndStatus security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - description: Contract in: query name: contract schema: type: integer - description: 'YYYY-MM-DD (start date): Filter POs by Created Date range' in: query name: date_0 schema: type: string format: date - description: 'YYYY-MM-DD (end date): Filter POs by Created Date range' in: query name: date_1 schema: type: string format: date - description: Expiry Date in: query name: expiry_date_0 schema: type: string format: date - description: Expiry Date in: query name: expiry_date_1 schema: type: string format: date - in: query name: has_blanket_order_items schema: type: boolean - description: 'YYYY-MM-DD (start date): Filter POs by Last Modified Date range' in: query name: modified_date_0 schema: type: string format: date - description: 'YYYY-MM-DD (end date): Filter POs by Last Modified Date range' in: query name: modified_date_1 schema: type: string format: date - description: Sort by field in: query name: order_by schema: type: string - in: query name: page schema: type: integer - in: query name: page_size schema: type: integer - description: ID of Vendor in: query name: pref_vendor schema: type: integer - description: 'YYYY-MM-DD (start date): Filter POs by Promise Date range' in: query name: promise_date_0 schema: type: string format: date - description: 'YYYY-MM-DD (end date): Filter POs by Promise Date range' in: query name: promise_date_1 schema: type: string format: date - in: path name: role schema: type: string enum: - purchased - receivable required: true - in: path name: status schema: type: string enum: - all - cancelled - closed - open - paid - partial required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/POWithListPurchaseOrderDocs' text/csv: schema: $ref: '#/components/schemas/POWithListPurchaseOrderDocs' /api/v3/account-codes: get: tags: - account-codes summary: Get Account Codes operationId: Accountcodes_list security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: |- **Account Code Types** | Account Code Type | Type | |-------------------|------| | ASSETS | 0 | | LIABILITY | 1 | | EXPENSE | 2 | | INCOME | 3 | | EQUITY | 4 | | OTHER | 5 | parameters: - in: query name: active schema: type: boolean - in: query name: code schema: type: string - in: query name: format schema: type: string enum: - csv - json - in: query name: is_parent schema: type: boolean - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedAccountCodeReadList' text/csv: schema: $ref: '#/components/schemas/PaginatedAccountCodeReadList' post: tags: - account-codes summary: Create Account Codes operationId: Accountcodes_createAccountCodes security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: |- **Account Code Types** | Account Code Type | Type | |-------------------|------| | ASSETS | 0 | | LIABILITY | 1 | | EXPENSE | 2 | | INCOME | 3 | | EQUITY | 4 | | OTHER | 5 | parameters: - in: query name: format schema: type: string enum: - csv - json requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountCodeCreateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountCodeCreateRequest' '': schema: $ref: '#/components/schemas/AccountCodeCreateRequest' application/xml: schema: $ref: '#/components/schemas/AccountCodeCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/AccountCodeCreateRequest' required: true responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AccountCodeReadSerializerSingleCreate' text/csv: schema: $ref: '#/components/schemas/AccountCodeReadSerializerSingleCreate' /api/v3/account-codes/{id}: put: tags: - account-codes summary: Update Account Code operationId: Accountcodes_updateAccountCode security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: |- **Account Code Types** | Account Code Type | Type | |-------------------|------| | ASSETS | 0 | | LIABILITY | 1 | | EXPENSE | 2 | | INCOME | 3 | | EQUITY | 4 | | OTHER | 5 | parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this account code. in: path name: id schema: type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountCodeUpdateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountCodeUpdateRequest' '': schema: $ref: '#/components/schemas/AccountCodeUpdateRequest' application/xml: schema: $ref: '#/components/schemas/AccountCodeUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/AccountCodeUpdateRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AccountCodeReadSerializerSingleUpdate' text/csv: schema: $ref: '#/components/schemas/AccountCodeReadSerializerSingleUpdate' /api/v3/accounts: get: tags: - accounts summary: Get Accounts operationId: accounts_list security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: account_code schema: type: integer - in: query name: active schema: type: boolean - in: query name: department schema: type: integer - description: A comma-separated list of integers. in: query name: departments schema: type: string - in: query name: format schema: type: string enum: - csv - json - in: query name: id schema: type: integer - in: query name: in_effect schema: type: boolean - description: A comma-separated list of integers. in: query name: locations schema: type: string - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string - in: query name: with_expired_budgets schema: type: boolean responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedChartOfAccountsAccountList' text/csv: schema: $ref: '#/components/schemas/PaginatedChartOfAccountsAccountList' /api/v3/ap/bills: get: tags: - ap summary: Get Bills operationId: Ap_billsList security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: >- list: This endpoint supports OPTIONS method which returns a list of available fields and their types. parameters: - description: Approver in: query name: approver schema: type: number - description: Contracts related to bill items' purchase orders in: query name: contract schema: type: number - in: query name: currency schema: type: integer - description: Due Date in: query name: due_date_0 schema: type: string format: date - description: Due Date in: query name: due_date_1 schema: type: string format: date - in: query name: exclude_bill_group_ids schema: type: string - description: Exclude expense bills in: query name: exclude_expense_bills schema: type: string - description: Expense Bills Only in: query name: expense schema: type: string - in: query name: format schema: type: string enum: - csv - json - description: Posting Date in: query name: gl_post_date_0 schema: type: string format: date - description: Posting Date in: query name: gl_post_date_1 schema: type: string format: date - in: query name: group schema: type: integer - description: Without Payment in: query name: has_payment schema: type: boolean - description: Has Posting Date in: query name: has_posting_date schema: type: boolean - in: query name: include_bill_group_ids schema: type: string - description: Invoice Date in: query name: invoice_date_0 schema: type: string format: date - description: Invoice Date in: query name: invoice_date_1 schema: type: string format: date - description: Exported Bills Only in: query name: is_exported schema: type: boolean - description: Last Export Date in: query name: last_export_date_0 schema: type: string format: date - description: Last Export Date in: query name: last_export_date_1 schema: type: string format: date - description: Last Export User in: query name: last_export_user schema: type: number - description: Last Modified Datetime in: query name: last_modified_datetime_0 schema: type: string format: date-time - description: Last Modified Datetime in: query name: last_modified_datetime_1 schema: type: string format: date-time - description: Last Modified Date (Deprecated - use 'Last Modified Datetime') in: query name: modified_date_0 schema: type: string format: date - description: Last Modified Date (Deprecated - use 'Last Modified Datetime') in: query name: modified_date_1 schema: type: string format: date - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string - description: Submitted Date in: query name: submitted_date_0 schema: type: string format: date - description: Submitted Date in: query name: submitted_date_1 schema: type: string format: date - description: Sync Status in: query name: sync_status schema: type: string - description: Sync Status in: query name: sync_status_v2 schema: type: string - in: query name: type schema: type: integer enum: - 0 - 1 - 2 - in: query name: user schema: type: integer - in: query name: vendor schema: type: integer responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BillMetadataListSimpleBill' text/csv: schema: $ref: '#/components/schemas/BillMetadataListSimpleBill' /api/v3/catalog-bundles: get: tags: - catalog summary: Get All Catalog Bundles operationId: Catalog_getAllBundles security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedCatalogItemBundleReadList' text/csv: schema: $ref: '#/components/schemas/PaginatedCatalogItemBundleReadList' /api/v3/catalog-items: get: tags: - catalog summary: Get All Catalog Items operationId: Catalog_getAllItems security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: bundle schema: type: integer - description: A comma-separated list of integers. in: query name: department schema: type: string - in: query name: format schema: type: string enum: - csv - json - in: query name: internalSKU schema: type: string - description: A comma-separated list of integers. in: query name: location schema: type: string - in: query name: max_price schema: type: number - in: query name: min_price schema: type: number - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - in: query name: pref_vendor schema: type: integer - description: A search term. name: search required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedCatalogItemReadList' text/csv: schema: $ref: '#/components/schemas/PaginatedCatalogItemReadList' post: tags: - catalog summary: Create Catalog Item operationId: Catalog_itemCreate security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json requestBody: content: application/json: schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' '': schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' application/xml: schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' multipart/form-data: schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' required: true responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CatalogItemReadSerializerSingleCreate' text/csv: schema: $ref: '#/components/schemas/CatalogItemReadSerializerSingleCreate' /api/v3/catalog-items/{id}: put: tags: - catalog summary: Update Catalog Item operationId: Catalog_updateItem security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this catalog items. in: path name: id schema: type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' '': schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' application/xml: schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' multipart/form-data: schema: $ref: '#/components/schemas/CatalogItemUpsertRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CatalogItemReadSerializerSingleUpdate' text/csv: schema: $ref: '#/components/schemas/CatalogItemReadSerializerSingleUpdate' /api/v3/custom-fields/{id}: put: tags: - custom-fields summary: Update Order Item Custom Field Dropdown Choices operationId: Customfields_updateOrderItemCustomFieldDropdownChoices security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: ' ' parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this custom field. in: path name: id schema: type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomFieldUpdateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CustomFieldUpdateRequest' '': schema: $ref: '#/components/schemas/CustomFieldUpdateRequest' application/xml: schema: $ref: '#/components/schemas/CustomFieldUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/CustomFieldUpdateRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CustomFieldReadSerializerSingle' text/csv: schema: $ref: '#/components/schemas/CustomFieldReadSerializerSingle' /api/v3/custom-fields/order-items: get: tags: - custom-fields summary: Get Active/Inactive Order Item Custom Fields operationId: Customfields_getOrderItemCustomFields security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: Get list of custom fields associated with order items parameters: - in: query name: field_type schema: type: string enum: - a - b - d - f - h - i - m - t - in: query name: format schema: type: string enum: - csv - json - in: query name: meta__is_active schema: type: boolean - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedCustomFieldReadList' text/csv: schema: $ref: '#/components/schemas/PaginatedCustomFieldReadList' /api/v3/departments: get: tags: - departments summary: List Departments operationId: departments_list security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: ' ' parameters: - description: Filter departments by their branch. in: query name: branch schema: type: integer - in: query name: format schema: type: string enum: - csv - json - description: >- Setting this adds the addition of the booeal field 'has_active_account' to each department object of the response. The query param accepts an integer representing the primary key of the account code to check if there exists an account object associated with the department with that account code. in: query name: include_is_active_for_account_code schema: type: integer - description: >- Setting this overrides the need to enable the PROCUREMENT_ACCESS and/or RECEIVE_BY_DEPARTMENT feature switches. This parameter can only be used in conjunction with permission and user and cannot function without both of those parameters explicitly set. in: query name: location_perm_override schema: type: boolean - description: Filter departments by the locations (branches) passed in. in: query name: locations schema: type: array items: type: integer - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: >- Filter by permission. In isolation, this parameter can only be set to 68 (add purchase order); 841 (view report); or 899 (receive_po), which correlate with permission to add purchase orders, view reports, and receive purchase orders respectively. However, the results returned correlate with the “by department” version of these permissions, which means that results are filtered by permission to add purchase orders by department, permission to view reports by department, and receive purchase orders by department. This should only be used in conjunction with the PROCUREMENT_ACCESS and/or RECEIVE_BY_DEPARTMENT feature switches. If used in conjunction with location_perm_override=true and user, the value can be set to any permission, and the result will be departments filtered by the provided user and permission values. If used in conjunction with the RECEIVE_BY_DEPARTMENT feature flag, the permission can only be set to 68, 841, or 899 (see second sentence for what these permissions do). The result will be all departments filtered by the provided user value. in: query name: permission schema: type: integer - description: >- Fetch all requestable departments by the currently authorized user. Accepts ORDER, EXPENSE, TRAVEL, and PAY_REQUEST. in: query name: requestable schema: type: string - description: A search term. name: search required: false in: query schema: type: string - description: >- Filter by user. If this parameter is set, the user must be a superuser or have the add_po_by_department or receive_po_by_department permissions. In isolation, this parameter should only be used in conjunction with the PROCUREMENT_ACCESS and/or RECEIVE_BY_DEPARTMENT feature switches. If used in conjunction with location_perm_override=true and permission query parameter, the result returned will be departments filtered by the provided user and permission values. If used in conjunction with the RECEIVE_BY_DEPARTMENT feature flag, the result will be departments filtered by the user provided and the permission set to 68 (add purchase order); 841 (view report); or 899 (receive purchase order) (see permission query parameter explanation for more information on what these stand for). in: query name: user schema: type: integer responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedDepartmentReadList' text/csv: schema: $ref: '#/components/schemas/PaginatedDepartmentReadList' post: tags: - departments summary: Create New Department operationId: departments_create security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: ' ' parameters: - in: query name: format schema: type: string enum: - csv - json requestBody: content: application/json: schema: $ref: '#/components/schemas/DepartmentUpsertRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DepartmentUpsertRequest' '': schema: $ref: '#/components/schemas/DepartmentUpsertRequest' application/xml: schema: $ref: '#/components/schemas/DepartmentUpsertRequest' multipart/form-data: schema: $ref: '#/components/schemas/DepartmentUpsertRequest' required: true responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/DepartmentReadSerializerSingleCreate' text/csv: schema: $ref: '#/components/schemas/DepartmentReadSerializerSingleCreate' /api/v3/departments/{id}: put: tags: - departments summary: Update Department operationId: departments_update security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: ' ' parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this department. in: path name: id schema: type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/DepartmentUpsertRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DepartmentUpsertRequest' '': schema: $ref: '#/components/schemas/DepartmentUpsertRequest' application/xml: schema: $ref: '#/components/schemas/DepartmentUpsertRequest' multipart/form-data: schema: $ref: '#/components/schemas/DepartmentUpsertRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DepartmentReadSerializerSingleUpdate' text/csv: schema: $ref: '#/components/schemas/DepartmentReadSerializerSingleUpdate' /api/v3/order-items: get: tags: - order-items summary: Get list of all order items operationId: Orderitems_listItems security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] 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. | parameters: - in: query name: account schema: type: integer - description: Account Code in: query name: account_code schema: type: integer - in: query name: active schema: type: boolean - description: Approved Date 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 - 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 - description: Location in: query name: branch schema: type: integer - in: query name: catalog schema: type: boolean - description: A comma-separated list of integers. in: query name: catalog_item schema: type: string - in: query name: currency schema: type: integer - description: Department in: query name: department schema: type: integer - description: A comma-separated list of integers. in: query name: departments schema: type: string - description: A comma-separated list of integers. in: query name: exclude schema: type: string - 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 - description: Last Modified Date 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 - in: query name: lineComment schema: type: string - description: Location in: query name: location schema: type: integer - description: A comma-separated list of integers. in: query name: locations schema: type: string - 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: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: Order Created Date 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: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: Purchased Date 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 Vendor in: query name: po_vendor schema: type: integer - in: query name: pref_vendor schema: type: integer - in: query name: price schema: type: number - in: query name: purchase_agreement schema: type: number - description: Purchased Date 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 - 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 - description: Requester in: query name: requester schema: type: integer - description: A search term. name: search required: false in: query 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 - in: query name: type schema: type: integer enum: - 0 - 1 - 2 - in: query name: unit schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedOrderItemList' text/csv: schema: $ref: '#/components/schemas/PaginatedOrderItemList' /api/v3/permissions: get: tags: - permissions summary: Get Available User Permissions operationId: permissions_list security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedPermissionReadList' examples: UserPermissions: summary: User Permissions value: data: - id: 507 codename: add_bill - id: 889 codename: approve_bill - id: 528 codename: add_monthclose - id: 1 codename: add_permission - id: 7 codename: add_user - id: 582 codename: add_paymentterm - id: 591 codename: add_shippingmethod - id: 585 codename: add_shippingterm - id: 329 codename: add_integration - id: 645 codename: add_creditcard metadata: pagination: count: 64 num_pages: 7 current_page: 1 page_size: 10 next: >- https://antonio.dev.procurify.xyz/api/v3/permissions/?page=2 previous: null text/csv: schema: $ref: '#/components/schemas/PaginatedPermissionReadList' /api/v3/permissions/groups: get: tags: - permissions summary: Get Available System Roles operationId: Permissions_getAvailableSystemRoles security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - in: query name: permission schema: type: string - description: A search term. name: search required: false in: query schema: type: string - in: query name: type schema: type: integer - in: query name: user schema: type: integer - in: query name: userprofile schema: type: integer responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedPermissionGroupList' examples: SystemRoles: summary: System Roles value: data: - id: 5 name: Approver user_count: 0 permissions: - id: 900 codename: view_reports - id: 982 codename: view_reports_budgets - id: 977 codename: view_reports_expenses_by_department - id: 976 codename: view_reports_orders_by_department - id: 975 codename: view_reports_orders_by_user - id: 974 codename: view_reports_orders_by_vendor - id: 101 codename: add_expensereport - id: 887 codename: approve_expensereport - id: 71 codename: add_order - id: 886 codename: approve_order - id: 95 codename: add_travel - id: 888 codename: approve_travel type: 1 metadata: pagination: count: 8 num_pages: 8 current_page: 1 page_size: 1 next: >- https://antonio.dev.procurify.xyz/api/v3/permissions/groups/?page=2&page_size=1&permission=886 previous: null text/csv: schema: $ref: '#/components/schemas/PaginatedPermissionGroupList' /api/v3/purchase-orders/{procurify_PO}: put: tags: - purchase-orders summary: Update a Purchase Order operationId: Purchaseorders_updateOrder security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this po. in: path name: procurify_PO schema: title: Procurify PO Number type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' '': schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' application/xml: schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PurchaseOrderUpdateRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderUpdateSerializerSingle' text/csv: schema: $ref: '#/components/schemas/PurchaseOrderUpdateSerializerSingle' /api/v3/purchase-orders/{procurify_PO}/close: post: tags: - purchase-orders summary: Close a Purchase Order operationId: Purchaseorders_closeOrder security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this po. in: path name: procurify_PO schema: title: Procurify PO Number type: integer required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderReadDocsSerializerSingle' text/csv: schema: $ref: '#/components/schemas/PurchaseOrderReadDocsSerializerSingle' /api/v3/purchase-orders/{procurify_PO}/reopen: post: tags: - purchase-orders summary: Reopen a Purchase Order operationId: Purchaseorders_reopenProcurifyPo security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this po. in: path name: procurify_PO schema: title: Procurify PO Number type: integer required: true responses: '200': description: No response body /api/v3/purchase-orders/billing-history: get: tags: - purchase-orders summary: View billing history of a Purchase Order operationId: Purchaseorders_viewBillingHistory security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderBillingHistorySerializerList' text/csv: schema: $ref: '#/components/schemas/PurchaseOrderBillingHistorySerializerList' /api/v3/requisitions: post: tags: - requisitions summary: Creating a requisition operationId: requisitions_create security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json 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 responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/RequisitionReadSerializerSingle' text/csv: schema: $ref: '#/components/schemas/RequisitionReadSerializerSingle' /api/v3/users: get: tags: - users summary: List Users operationId: users_list security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - in: query name: is_active schema: type: boolean - in: query name: location schema: type: string - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - in: query name: pending_invite schema: type: boolean - in: query name: permission schema: type: string - in: query name: role schema: type: number - description: A search term. name: search required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedUserProfileUnoptimizedList' text/csv: schema: $ref: '#/components/schemas/PaginatedUserProfileUnoptimizedList' post: tags: - users summary: Create New User operationId: users_create security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json requestBody: content: application/json: schema: $ref: '#/components/schemas/UsersCreateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UsersCreateRequest1' '': schema: $ref: '#/components/schemas/UsersCreateRequest2' application/xml: schema: $ref: '#/components/schemas/UsersCreateRequest3' multipart/form-data: schema: $ref: '#/components/schemas/UsersCreateRequest4' required: true responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/UserProfileUnoptimizedSerializerList' text/csv: schema: $ref: '#/components/schemas/UserProfileUnoptimizedSerializerList' /api/v3/users/{id}: put: tags: - users summary: Update User operationId: users_update security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this user profile. in: path name: id schema: type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UserProfileUpsertRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserProfileUpsertRequest' '': schema: $ref: '#/components/schemas/UserProfileUpsertRequest' application/xml: schema: $ref: '#/components/schemas/UserProfileUpsertRequest' multipart/form-data: schema: $ref: '#/components/schemas/UserProfileUpsertRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserProfileUnoptimizedSerializerSingle' text/csv: schema: $ref: '#/components/schemas/UserProfileUnoptimizedSerializerSingle' delete: tags: - users summary: Deactivate User operationId: users_destroy security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this user profile. in: path name: id schema: type: integer required: true responses: '204': description: No response body /api/v3/users/me: get: tags: - users summary: Get Logged-in User operationId: Users_getLoggedInUser security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: Get the logged in user account information parameters: - in: query name: format schema: type: string enum: - csv - json responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserProfileMeSerializerSingle' examples: Logged-inUser: summary: Logged-in User value: data: id: 2 domains: active: false procurify_domains: - subdomain: example.com name: example.com headquarter_logo: >- https://commondatastorage.googleapis.com/cdn.procurify.com/attachments/7e3c3a59-8e37-4575-b510-508aeea9ee43 systemaccess_cache: structured: '1': flattened: - nav_receive - nav_approval - nav_manage - nav_request - nav_purchase - nav_report - nav_setting roles: - permissions: - description: Navigation for Request id: 3 name: Request - description: Navigation for Approval id: 4 name: Approval - description: Navigation for Purchase id: 5 name: Purchase - description: Navigation for Receive id: 6 name: Receive - description: Navigation for Manage id: 7 name: Manage - description: Navigation for Settings id: 8 name: Settings - description: Navigation for Report id: 9 name: Report id: 15 name: Location Manager '2': flattened: - nav_request - nav_approval - nav_report roles: - permissions: - description: Navigation for Request id: 3 name: Request - description: Navigation for Approval id: 4 name: Approval - description: Navigation for Report id: 9 name: Report id: 25 name: Approver '3': flattened: - nav_request - nav_approval - nav_report roles: - permissions: - description: Navigation for Request id: 3 name: Request - description: Navigation for Approval id: 4 name: Approval - description: Navigation for Report id: 9 name: Report id: 25 name: Approver system: flattened: - superuser - accounts_payable roles: - permissions: - description: Full Access id: 2 name: Superuser id: 2 name: Superuser - permissions: - description: Accounts Payable id: 12 name: Accounts Payable id: 31 name: AP flattened: - superuser - nav_manage - nav_request - nav_purchase - accounts_payable - nav_receive - nav_setting - nav_approval - nav_report approval_delegatee: null is_approval_delegatee: false department: branch: name: '' url: '' logo: null currency: description: '' name: '' rate: null base: false active: false phoneOne: '' fax: '' email: '' primary_billing_address: name: '' addressLineOne: '' city: '' postalCode: '' state_province: '' country: '' primary_shipping_address: name: '' addressLineOne: '' city: '' postalCode: '' state_province: '' country: '' language: null locationTimezone: null active: false external_id: '' external_id: '' name: '' active: false created_at: '2017-03-17T21:45:36.120222Z' updated_at: '2017-03-24T00:55:40.724146Z' firstName: Frank lastName: Borman email: nick+redshift7@procurify.com position: '' phone: '-' address: '' notifications: true is_active: true pending_invite: false role: 7 mobile: false profile_image: nickredshift7procurifycom_aa1fbc9b_frank-borman.jpg slack_user_id: '' is_sso_enabled: false last_changed_by: null user: 2 metadata: {} text/csv: schema: $ref: '#/components/schemas/UserProfileMeSerializerSingle' /api/v3/vendors: get: tags: - vendors summary: Get list of all active vendors operationId: vendors_list security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: >- **Vendor Type Codes** | Vendor Type | Type | Description | |---------------------|-----------|-----------------------------------| | OTHER | 1 | Previously 'OTHER' vendor (ID=1), used for storing non-vendor | | | for storing non-vendor Vendor names in request. | | HIDDEN | 2 | New type of vendors that is reserved for system purposes (eg. Amazon Business). | | PREFERRED (default) | 3 | The default vendors from previous list | | | where active vendor dropdowns everywhere previously showed. | | | Request now ONLY shows these vendors (+OTHER) | | REGULAR | 4 | New type of vendors that are non-preferred, | | | for any AP purposes and purchasers to update. | | | (DOES NOT show up in Request, but shows up in Procure) | | EMPLOYEE | 5 | New type of vendors that do not show up anywhere except in AP employees list. | | CC_PROVIDER | 6 | Similar type of vendors to AP employees, but for AP credit card providers. | parameters: - in: query name: exclude_other schema: type: boolean - in: query name: external_id schema: type: string - in: query name: format schema: type: string enum: - csv - json - in: query name: name schema: type: string - description: Which field to use when ordering the results. name: order_by required: false in: query schema: type: string - description: A page number within the paginated result set. name: page required: false in: query schema: type: integer - description: Number of results to return per page. name: page_size required: false in: query schema: type: integer - description: A search term. name: search required: false in: query schema: type: string - description: Type of the vendor. See above for possible options. in: query name: type schema: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - description: >- **"all"**: Get list of all vendors. **"credit_card_providers"**: Get list of credit card provider vendors. These vendors are displayed in Payee Management for Credit Card Providers. **"default"**: Get list of "preferred" and "regular" vendors. These vendors are displayed in Procure (procurement, vendors, etc) and AP i.e., default vendor list. OTHER is discontinued from procure. **"other"**: Get list of "other" vendors. Only returns the 'OTHER' vendor reserved for requesting non-vendor names. **"preferred"**: Get list of "preferred" vendors. **"purchasable"**: Get list of "purchasable" vendors. **"requestable"**: Get list of "requestable" vendors. These vendors are displayed in Request and designated by Purchaser. in: path name: vendor_group schema: type: string enum: - all - credit_card_providers - default - other - preferred - purchasable - requestable required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedOptimizedVendorList' text/csv: schema: $ref: '#/components/schemas/PaginatedOptimizedVendorList' post: tags: - vendors summary: Create Vendor operationId: vendors_create security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: |- Create a new vendor Due to having multiple vendors with the same name, especially common if user keeps deleting vendors with the same name, these deleted vendors get thrown into the inactive list. **Vendor Types** | Vendor Type | Type | |---------------------|-----------| | OTHER | 1 | | HIDDEN | 2 | | PREFERRED (default) | 3 | | REGULAR | 4 | | EMPLOYEE | 5 | | CC_PROVIDER | 6 | parameters: - in: query name: format schema: type: string enum: - csv - json requestBody: content: application/json: schema: $ref: '#/components/schemas/OptimizedVendorRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OptimizedVendorRequest' '': schema: $ref: '#/components/schemas/OptimizedVendorRequest' application/xml: schema: $ref: '#/components/schemas/OptimizedVendorRequest' multipart/form-data: schema: $ref: '#/components/schemas/OptimizedVendorRequest' required: true responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/VendorDetailSerializerSingleCreate' text/csv: schema: $ref: '#/components/schemas/VendorDetailSerializerSingleCreate' /api/v3/vendors/{id}: get: tags: - vendors summary: Get Vendor by ID operationId: vendors_retrieve security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] description: Get detail of a vendor by id parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this vendor. in: path name: id schema: type: integer required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/VendorDetailSerializerSingleRetrieve' text/csv: schema: $ref: '#/components/schemas/VendorDetailSerializerSingleRetrieve' put: tags: - vendors summary: Update Vendor operationId: vendors_update security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this vendor. in: path name: id schema: type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/OptimizedVendorRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OptimizedVendorRequest' '': schema: $ref: '#/components/schemas/OptimizedVendorRequest' application/xml: schema: $ref: '#/components/schemas/OptimizedVendorRequest' multipart/form-data: schema: $ref: '#/components/schemas/OptimizedVendorRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/VendorSerializerSingle' text/csv: schema: $ref: '#/components/schemas/VendorSerializerSingle' patch: tags: - vendors summary: Partial Update Vendor operationId: Vendors_partialUpdate security: - M2MAuthentication: [] - RemoteAuthentication: [] - BasicAuthentication: [] - tokenAuth: [] - cookieAuth: [] parameters: - in: query name: format schema: type: string enum: - csv - json - description: A unique integer value identifying this vendor. in: path name: id schema: type: integer required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOptimizedVendorRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedOptimizedVendorRequest' '': schema: $ref: '#/components/schemas/PatchedOptimizedVendorRequest' application/xml: schema: $ref: '#/components/schemas/PatchedOptimizedVendorRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedOptimizedVendorRequest' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OptimizedVendorSerializerSingle' text/csv: schema: $ref: '#/components/schemas/OptimizedVendorSerializerSingle' components: schemas: APBillPaymentDocs: type: object properties: id: type: integer readOnly: true payment: $ref: '#/components/schemas/PaymentSimpleDocs' payment_method: $ref: '#/components/schemas/PaymentMethodDocs' amount: title: Payment Amount type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ transaction: type: integer nullable: true required: - payment - payment_method APCreditCard: type: object properties: id: type: integer readOnly: true uuid: type: string format: uuid is_active: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true name: type: string maxLength: 255 number: type: string pattern: ^[0-9]{4}$ maxLength: 19 balance: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true gl_code: type: string maxLength: 100 type: $ref: '#/components/schemas/CreditCardTypeEnum' category: nullable: true minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/ZeroOneEnum' - $ref: '#/components/schemas/NullEnum' type: integer external_id: description: External id of the Credit Card type: string maxLength: 100 status: description: The status of the Credit Card nullable: true oneOf: - $ref: '#/components/schemas/CreditCardStatusEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' type: integer require_activation: title: Require new activation? description: Does this card require new activation? type: boolean last_changed_by: title: Last changed by user type: integer nullable: true vendor: type: integer payment_method: type: integer nullable: true currency: type: integer creator: title: Card Issuer type: integer nullable: true required: - currency - uuid - vendor x-konfig-properties: type: minimum: -2147483648 maximum: 2147483647 Account: type: object properties: id: type: integer readOnly: true account_code: $ref: '#/components/schemas/AccountCodeRead' department: $ref: '#/components/schemas/DepartmentSummary' warning_indicator: type: boolean readOnly: true start_datetime: type: string format: date-time nullable: true end_datetime: type: string format: date-time nullable: true budget: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ budget_used_approved: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ budget_used_purchased: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ balance_approved: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ balance_purchased: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ active: type: boolean required: - account_code - department AccountCodeCreateRequest: type: object properties: description: type: string minLength: 1 maxLength: 200 code: type: string minLength: 1 maxLength: 50 parent: type: integer nullable: true account_type: $ref: '#/components/schemas/ExpenseTypeEnum' departments: type: array items: type: integer required: - code - description x-konfig-properties: account_type: minimum: -2147483648 maximum: 2147483647 AccountCodeRead: type: object properties: description: type: string maxLength: 200 id: type: integer readOnly: true applied_accounts_count: type: integer readOnly: true code: type: string maxLength: 50 code_length: type: integer maximum: 2147483647 minimum: -2147483648 account_type: $ref: '#/components/schemas/ExpenseTypeEnum' active: type: boolean parent: type: integer nullable: true required: - code - description x-konfig-properties: account_type: minimum: -2147483648 maximum: 2147483647 AccountCodeReadSerializerSingleCreate: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/AccountCodeRead' required: - data AccountCodeReadSerializerSingleUpdate: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/AccountCodeRead' required: - data AccountCodeUpdateRequest: type: object properties: description: type: string minLength: 1 maxLength: 200 code: type: string minLength: 1 maxLength: 50 account_type: $ref: '#/components/schemas/ExpenseTypeEnum' required: - code - description x-konfig-properties: account_type: minimum: -2147483648 maximum: 2147483647 AccountRead: type: object properties: id: type: integer readOnly: true account_code: $ref: '#/components/schemas/AccountCodeRead' department: $ref: '#/components/schemas/DepartmentSummary' warning_indicator: type: boolean readOnly: true budget_used_approved: type: number format: float budget_used_purchased: type: number format: float start_datetime: type: string format: date-time nullable: true end_datetime: type: string format: date-time nullable: true budget: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ balance_approved: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ balance_purchased: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ active: type: boolean required: - account_code - department 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 Address: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 150 addressLineOne: title: Address line 1 type: string maxLength: 300 city: type: string maxLength: 50 postalCode: title: Postal Code type: string maxLength: 20 state_province: title: State/Province type: string maxLength: 40 country: type: string maxLength: 80 required: - addressLineOne - city - country - name - postalCode AddressAssociationEnum: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer AddressDocs: type: object properties: id: type: integer name: type: string required: - id - name AddressRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 addressLineOne: title: Address line 1 type: string minLength: 1 maxLength: 300 city: type: string minLength: 1 maxLength: 50 postalCode: title: Postal Code type: string minLength: 1 maxLength: 20 state_province: title: State/Province type: string maxLength: 40 country: type: string minLength: 1 maxLength: 80 required: - addressLineOne - city - country - name - postalCode AddressSummary: type: object properties: id: type: integer readOnly: true is_active: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true name: type: string maxLength: 150 addressAssociation: $ref: '#/components/schemas/AddressAssociationEnum' addressLineOne: title: Address line 1 type: string maxLength: 300 addressLineTwo: title: Address line 2 type: string maxLength: 300 postalCode: title: Postal Code type: string maxLength: 20 city: type: string maxLength: 50 state_province: title: State/Province type: string maxLength: 40 country: type: string maxLength: 80 last_changed_by: title: Last changed by user type: integer nullable: true required: - addressLineOne - city - country - name - postalCode x-konfig-properties: addressAssociation: minimum: -2147483648 maximum: 2147483647 Adjustment: type: object properties: id: type: integer type: $ref: '#/components/schemas/AdjustmentTypeEnum' value: type: string format: decimal pattern: ^\d{0,7}(?:\.\d{0,8})?$ name: type: string nullable: true required: - type - value AdjustmentTypeEnum: enum: - percent - amount - '0' - '1' type: string AllocationRead: type: object properties: id: type: integer readOnly: true amount: title: Allocated Amount type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ account: $ref: '#/components/schemas/SpendAccountRead' required: - account - amount ApiNestedEditDeletePurchaseOrderDetail: type: object properties: metadata: $ref: '#/components/schemas/PermissionsEditDelete' data: $ref: '#/components/schemas/PurchaseOrderDetail' required: - data - metadata 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 ApprovalDelegateeSlimDocs: type: object properties: id: type: integer readOnly: true firstName: type: string maxLength: 100 lastName: type: string maxLength: 100 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 ApproverChoicesMetadataApproverReadDocs: type: object properties: metadata: $ref: '#/components/schemas/ApproverChoicesMetadataDocs' data: type: array items: $ref: '#/components/schemas/ApproverReadDocs' required: - data - metadata ApproverChoicesMetadataDocs: type: object properties: summary: $ref: '#/components/schemas/PaymentSummaryDocs' permissions: $ref: '#/components/schemas/PermissionsApprove' required: - summary ApproverRead: type: object properties: id: type: integer readOnly: true user: $ref: '#/components/schemas/SimpleUserSummary' amount_limit: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ item_variance_amount_limit: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ nullable: true item_variance_percentage_limit: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ nullable: true approval_level: type: integer required: - amount_limit - approval_level - user ApproverReadDocs: type: object properties: id: type: integer readOnly: true user: $ref: '#/components/schemas/SimpleUserSummary' amount_limit: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ item_variance_amount_limit: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ nullable: true item_variance_percentage_limit: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ nullable: true approval_level: type: integer bill_amount_limit: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ required: - amount_limit - approval_level - bill_amount_limit - user Attachment: type: object properties: description: type: string maxLength: 1000 id: type: integer readOnly: true uuid: type: string format: uuid file: type: string name: type: string maxLength: 255 user: type: integer mimetype: type: string maxLength: 100 length: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true sha1_hash: type: string maxLength: 40 created_at: type: string format: date-time readOnly: true required: - file - user - uuid BillCostRead: type: object properties: id: type: integer readOnly: true cost_allocation: $ref: '#/components/schemas/CostAllocationRead' name: type: string maxLength: 100 amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ bill: type: integer cost: title: Cost Class type: integer nullable: true currency: type: integer nullable: true required: - amount - bill - cost_allocation - name BillDocs: type: object properties: id: type: integer readOnly: true uuid: type: string format: uuid readOnly: true vendor: $ref: '#/components/schemas/VendorDocs' tax_amount: type: number format: double readOnly: true vendor_name: type: string maxLength: 100 due_date: title: Bill Due Date type: string format: date-time nullable: true status: $ref: '#/components/schemas/BillStatusEnum' type: $ref: '#/components/schemas/ZeroOneTwoEnum' group: type: integer required: - group - vendor x-konfig-properties: status: minimum: 0 maximum: 4294967295 type: minimum: 0 maximum: 4294967295 BillItemsMetadataDocs: type: object properties: summary: $ref: '#/components/schemas/BillItemsSummaryDocs' pagination: $ref: '#/components/schemas/PaginationDocs' required: - pagination - summary BillItemsSummaryDocs: type: object properties: total_items: type: integer total_cost: type: number format: float required: - total_cost - total_items BillListViewApproverUserDocs: type: object properties: firstName: type: string maxLength: 100 lastName: type: string maxLength: 100 profile_image: type: string nullable: true approval_delegatee: $ref: '#/components/schemas/ApprovalDelegateeSlimDocs' required: - approval_delegatee BillMetadataBillRead: type: object properties: metadata: $ref: '#/components/schemas/SingleBillMetadataDocs' data: $ref: '#/components/schemas/BillRead' required: - data - metadata BillMetadataListSimpleBill: type: object properties: metadata: $ref: '#/components/schemas/ListBillsMetadataDocs' data: type: array items: $ref: '#/components/schemas/SimpleBill' required: - data - metadata BillPaymentDocs: type: object properties: id: type: integer readOnly: true bill: $ref: '#/components/schemas/BillDocs' user: $ref: '#/components/schemas/UserDocs' payment_method: $ref: '#/components/schemas/VendorPaymentMethodRead' amount: title: Payment Amount type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ transaction: type: integer nullable: true required: - bill - payment_method - user BillPurchaseOrderDocs: type: object properties: id: type: integer number: type: string currency: type: string total_amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ required: - currency - id - number - total_amount BillRead: type: object properties: version: type: integer maximum: 4294967295 minimum: 0 format: int64 id: type: integer readOnly: true uuid: type: string format: uuid user: $ref: '#/components/schemas/UserSummary' vendor: $ref: '#/components/schemas/VendorRead' approval_chain: type: integer readOnly: true nullable: true approver: allOf: - $ref: '#/components/schemas/ApproverRead' nullable: true type: object items: type: array items: $ref: '#/components/schemas/ItemReadSerializer_v2' costs: type: array items: $ref: '#/components/schemas/BillCostRead' invoice_attachments: type: array items: $ref: '#/components/schemas/Attachment' bill_statuses: type: array items: $ref: '#/components/schemas/BillStatusRead' currency: $ref: '#/components/schemas/Currency' comments: type: array items: $ref: '#/components/schemas/Comment' readOnly: true version_choices: type: array items: $ref: '#/components/schemas/VersionChoicesDocs' readOnly: true tax_amount: type: number format: double readOnly: true inclusive_tax_amount: type: number format: double readOnly: true exclusive_tax_amount: type: number format: double readOnly: true subtotal_cost: type: number format: double readOnly: true total_cost: type: number format: double readOnly: true total_cost_with_tax: type: number format: double readOnly: true converted_total_cost: type: number format: double readOnly: true next_approver_choices: type: array items: $ref: '#/components/schemas/ApproverRead' nullable: true readOnly: true locked: type: boolean readOnly: true bill_payment: allOf: - $ref: '#/components/schemas/APBillPaymentDocs' nullable: true readOnly: true type: object creditcard: type: integer readOnly: true creditcard_name: type: string readOnly: true last_export_user: $ref: '#/components/schemas/SimpleUserSummary' last_export_date: type: string format: date readOnly: true vendor_name: type: string maxLength: 100 vendor_contact: type: string maxLength: 100 vendor_address_one: title: Vendor Address Line One type: string maxLength: 300 vendor_address_two: title: Vendor Address Line Two type: string maxLength: 300 vendor_postal_code: type: string maxLength: 10 vendor_city: type: string maxLength: 50 vendor_state_province: title: Vendor State/Province type: string maxLength: 40 vendor_country: type: string maxLength: 80 last_modified_datetime: title: Last Modified type: string format: date-time readOnly: true submitted_date: type: string format: date-time nullable: true invoice_number: type: string maxLength: 50 invoice_date: title: Bill Invoice Date type: string format: date-time nullable: true due_date: title: Bill Due Date type: string format: date-time nullable: true payment_terms: type: string maxLength: 100 status: $ref: '#/components/schemas/BillStatusEnum' type: $ref: '#/components/schemas/ZeroOneTwoEnum' active: type: boolean note: type: string gl_post_date: type: string format: date-time nullable: true group: type: integer nullable: true payment_method: title: Bill Payment Method type: integer nullable: true payment_method_name: type: string readOnly: true added_purchase_orders: type: array items: $ref: '#/components/schemas/BillPurchaseOrderDocs' readOnly: true shipping_amount: type: number format: double readOnly: true invoice_uuid: type: string readOnly: true required: - bill_statuses - costs - currency - invoice_attachments - items - user - uuid - vendor x-konfig-properties: last_export_user: readOnly: true status: minimum: 0 maximum: 4294967295 type: minimum: 0 maximum: 4294967295 BillStatusEnum: enum: - 0 - 1 - 2 - 3 - 6 - 7 - 8 - 4 - 5 type: integer BillStatusRead: type: object properties: id: type: integer readOnly: true user: $ref: '#/components/schemas/UserSummary' date: type: string format: date-time status: $ref: '#/components/schemas/BillStatusEnum' bill: type: integer required: - bill - date - status - user x-konfig-properties: status: minimum: 0 maximum: 4294967295 BillSummaryDocs: type: object properties: has_multiple_currency: type: boolean total_cost: type: number format: float required: - has_multiple_currency - total_cost BlankEnum: enum: - '' type: string BlanketOrderItemRead: type: object properties: price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ quantity: type: number format: double readOnly: true amount: type: number format: double readOnly: true required: - price Branch: type: object properties: id: type: integer readOnly: true external_id: description: External id type: string nullable: true maxLength: 100 name: type: string maxLength: 150 url: type: string format: uri nullable: true maxLength: 200 logo: type: string language: $ref: '#/components/schemas/LanguageEnum' 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 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 x-konfig-properties: language: minimum: -2147483648 maximum: 2147483647 BranchSummary: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 150 required: - name BreakdownDocs: type: object properties: score: type: number format: float weight: type: string format: decimal pattern: ^\d{0,1}(?:\.\d{0,1})?$ required: - score - weight CatalogItemBundleRead: type: object properties: description: type: string maxLength: 250 id: type: integer readOnly: true name: type: string maxLength: 100 image: type: string active: type: boolean items: type: array items: $ref: '#/components/schemas/CatalogItemReadSerializerWithQuantity' readOnly: true items_count: type: integer readOnly: true required: - name CatalogItemRead: type: object properties: description: type: string nullable: true id: type: integer readOnly: true name: type: string maxLength: 255 image: type: string unitType: type: string maxLength: 30 pref_vendor: $ref: '#/components/schemas/VendorRead' account_code: $ref: '#/components/schemas/AccountCodeRead' internalSKU: type: string maxLength: 50 product_url: type: string nullable: true currency: $ref: '#/components/schemas/CurrencySummary' price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ rfo_lock: type: boolean departments: type: array items: type: integer readOnly: true custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldValueRead' readOnly: true requested_count: type: integer maximum: 2147483647 minimum: -2147483648 last_requested_date: type: string format: date-time nullable: true selected_account: type: object additionalProperties: {} readOnly: true required: - account_code - currency - name - pref_vendor CatalogItemReadSerializerSingleCreate: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/CatalogItemRead' required: - data CatalogItemReadSerializerSingleUpdate: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/CatalogItemRead' required: - data CatalogItemReadSerializerWithQuantity: type: object properties: description: type: string nullable: true id: type: integer readOnly: true name: type: string maxLength: 255 image: type: string unitType: type: string maxLength: 30 pref_vendor: $ref: '#/components/schemas/VendorRead' account_code: $ref: '#/components/schemas/AccountCodeRead' internalSKU: type: string maxLength: 50 product_url: type: string nullable: true currency: $ref: '#/components/schemas/CurrencySummary' price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ rfo_lock: type: boolean departments: type: array items: type: integer readOnly: true custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldValueRead' readOnly: true requested_count: type: integer maximum: 2147483647 minimum: -2147483648 last_requested_date: type: string format: date-time nullable: true selected_account: type: object additionalProperties: {} readOnly: true quantity: type: number format: float required: - account_code - currency - name - pref_vendor - quantity CatalogItemUpsertRequest: type: object properties: description: type: string nullable: true id: type: integer name: type: string minLength: 1 maxLength: 255 image: type: string unitType: type: string maxLength: 30 pref_vendor: type: integer nullable: true account_code: type: integer nullable: true internalSKU: type: string maxLength: 50 product_url: type: string nullable: true currency: type: integer price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ rfo_lock: type: boolean departments: type: array items: type: integer custom_fields: type: array items: type: object additionalProperties: {} required: - currency - custom_fields - name ChartOfAccountsAccount: type: object properties: id: type: integer readOnly: true account_code: $ref: '#/components/schemas/AccountCodeRead' department: $ref: '#/components/schemas/DepartmentRead' start_datetime: type: string format: date-time nullable: true end_datetime: type: string format: date-time nullable: true budget: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ budget_used_approved: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ budget_used_purchased: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ balance_approved: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ balance_purchased: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ active: type: boolean required: - account_code - department Comment: type: object properties: userprofile: $ref: '#/components/schemas/UserSummary' id: type: integer readOnly: true comment: type: string readOnly: true submit_date: title: Date/time submitted type: string format: date-time x-konfig-properties: userprofile: readOnly: true CompanyPaymentMethod: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: object additionalProperties: {} currency: type: integer gl_code: type: string maxLength: 100 required: - data x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 CompanyPaymentMethodRead: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: object additionalProperties: {} currency: $ref: '#/components/schemas/Currency' gl_code: type: string required: - currency - data x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 CompanyPaymentMethodRequest: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: object additionalProperties: {} currency: type: integer gl_code: type: string maxLength: 100 required: - data x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 CostAllocationRead: type: object properties: id: type: integer readOnly: true budget: $ref: '#/components/schemas/AccountRead' object_id: type: integer maximum: 4294967295 minimum: 0 format: int64 nullable: true amount: title: Billed Amount type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ currency: $ref: '#/components/schemas/Currency' created_on: type: string format: date-time readOnly: true required: - amount - budget - currency CostDetails: type: object properties: subtotal: type: string format: decimal pattern: ^\d{0,8}(?:\.\d{0,8})?$ nullable: true total_cost: type: string format: decimal pattern: ^\d{0,8}(?:\.\d{0,8})?$ total_cost_in_base_currency: type: string format: decimal pattern: ^\d{0,8}(?:\.\d{0,8})?$ tax_amount: type: string format: decimal pattern: ^\d{0,8}(?:\.\d{0,8})?$ required: - tax_amount - total_cost - total_cost_in_base_currency CreditCard: type: object properties: id: type: integer readOnly: true uuid: type: string format: uuid is_active: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true name: type: string maxLength: 255 number: type: string pattern: ^[0-9]{4}$ maxLength: 19 balance: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true gl_code: type: string maxLength: 100 type: $ref: '#/components/schemas/CreditCardTypeEnum' category: nullable: true minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/ZeroOneEnum' - $ref: '#/components/schemas/NullEnum' type: integer external_id: description: External id of the Credit Card type: string maxLength: 100 status: description: The status of the Credit Card nullable: true oneOf: - $ref: '#/components/schemas/CreditCardStatusEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' type: integer require_activation: title: Require new activation? description: Does this card require new activation? type: boolean last_changed_by: title: Last changed by user type: integer nullable: true vendor: type: integer payment_method: type: integer nullable: true currency: type: integer creator: title: Card Issuer type: integer nullable: true required: - currency - uuid - vendor x-konfig-properties: type: minimum: -2147483648 maximum: 2147483647 CreditCardItemRead: type: object properties: id: type: integer readOnly: true creditcard: $ref: '#/components/schemas/APCreditCard' po: $ref: '#/components/schemas/PurchaseOrderRead' expense: $ref: '#/components/schemas/ExpenseDocs' creditcard_is_editable: type: boolean readOnly: true matched_statement_items: type: array items: $ref: '#/components/schemas/StatementItem' readOnly: true required: - creditcard - po x-konfig-properties: expense: readOnly: true CreditCardRead: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 number: type: string pattern: ^[0-9]{4}$ maxLength: 19 vendor: $ref: '#/components/schemas/SimpleVendor' type: $ref: '#/components/schemas/CreditCardTypeEnum' currency: $ref: '#/components/schemas/Currency' balance: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true assignees: type: array items: $ref: '#/components/schemas/SimpleUserSummary' last_reconciliation_date: type: string format: date-time readOnly: true last_reconciliation_balance: type: number format: double readOnly: true session: $ref: '#/components/schemas/SessionCreate' gl_code: type: string maxLength: 100 last_statement_date: type: string format: date-time readOnly: true required: - assignees - currency - vendor x-konfig-properties: type: minimum: -2147483648 maximum: 2147483647 session: readOnly: true CreditCardRequest: type: object properties: uuid: type: string format: uuid is_active: type: boolean name: type: string minLength: 1 maxLength: 255 number: type: string minLength: 1 pattern: ^[0-9]{4}$ maxLength: 19 balance: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true gl_code: type: string maxLength: 100 type: $ref: '#/components/schemas/CreditCardTypeEnum' category: nullable: true minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/ZeroOneEnum' - $ref: '#/components/schemas/NullEnum' type: integer external_id: description: External id of the Credit Card type: string maxLength: 100 status: description: The status of the Credit Card nullable: true oneOf: - $ref: '#/components/schemas/CreditCardStatusEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' type: integer require_activation: title: Require new activation? description: Does this card require new activation? type: boolean last_changed_by: title: Last changed by user type: integer nullable: true vendor: type: integer payment_method: type: integer nullable: true currency: type: integer creator: title: Card Issuer type: integer nullable: true required: - currency - uuid - vendor x-konfig-properties: type: minimum: -2147483648 maximum: 2147483647 CreditCardStatusEnum: enum: - pending - active - inactive - canceled - lost - stolen type: string CreditCardTypeEnum: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer Currency: type: object properties: description: type: string maxLength: 100 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 active: type: boolean required: - name - rate CurrencyRequest: type: object properties: description: type: string maxLength: 100 name: type: string minLength: 1 maxLength: 10 rate: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,6})?$ base: type: boolean active: type: boolean required: - name - rate 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 CustomFieldRead: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 200 content_type: type: integer default_value: type: string maxLength: 5000 is_required: type: boolean field_choices: type: array items: type: string readOnly: true field_type: $ref: '#/components/schemas/FieldTypeEnum' field_label: type: string readOnly: true is_active: type: boolean readOnly: true required: - content_type - name CustomFieldReadSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/CustomFieldRead' required: - data CustomFieldUpdateRequest: type: object properties: name: type: string minLength: 1 maxLength: 200 default_value: type: string maxLength: 5000 is_required: type: boolean field_type: type: string minLength: 1 field_choices: type: array items: type: string minLength: 1 default: [] required: - field_type - name CustomFieldValueRead: type: object properties: id: type: integer readOnly: true value: oneOf: - type: string - type: boolean readOnly: true field: $ref: '#/components/schemas/CustomFieldRead' required: - field DepartmentIdValidationRequest: type: object properties: id: type: integer minimum: 1 required: - id DepartmentLocationRead: type: object properties: id: type: integer readOnly: true branch: $ref: '#/components/schemas/LocationView' external_id: description: External id type: string nullable: true maxLength: 100 name: type: string maxLength: 150 active: type: boolean punchout_email: type: string nullable: true is_active_for_account_code: type: boolean readOnly: true required: - branch - name DepartmentRead: type: object properties: id: type: integer readOnly: true branch: $ref: '#/components/schemas/LocationSimple' external_id: description: External id type: string nullable: true maxLength: 100 name: type: string maxLength: 150 active: type: boolean punchout_email: type: string nullable: true is_active_for_account_code: type: boolean readOnly: true required: - branch - name DepartmentReadSerializerSingleCreate: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/DepartmentRead' required: - data DepartmentReadSerializerSingleUpdate: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/DepartmentRead' required: - data DepartmentSummary: type: object properties: id: type: integer readOnly: true branch: $ref: '#/components/schemas/BranchSummary' external_id: description: External id type: string nullable: true maxLength: 100 name: type: string maxLength: 150 punchout_email: description: PunchOut Email type: string format: email nullable: true maxLength: 254 active: type: boolean required: - branch - name DepartmentUpsertRequest: type: object properties: branch: type: integer external_id: description: External id type: string nullable: true maxLength: 100 name: type: string minLength: 1 maxLength: 150 active: type: boolean punchout_email: type: string nullable: true minLength: 1 required: - branch - name DomainSwitching: type: object properties: active: type: boolean procurify_domains: type: array items: $ref: '#/components/schemas/ProcurifyDomain' required: - active - procurify_domains ExpenseDocs: type: object properties: merchant: type: string notes: type: string nullable: true expenseReport: $ref: '#/components/schemas/ExpenseReportWithUserDocs' required: - expenseReport - merchant - notes ExpenseRead: type: object properties: id: type: integer readOnly: true account: $ref: '#/components/schemas/Account' localCurrency: $ref: '#/components/schemas/CurrencySummary' expense_type_fields: type: object additionalProperties: {} expenseReport: $ref: '#/components/schemas/SimpleExpenseReport' requester: $ref: '#/components/schemas/SimpleUserSummary' approver: $ref: '#/components/schemas/SimpleUserSummary' approved_date: type: string format: date-time readOnly: true is_active: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true merchant: type: string maxLength: 100 transDate: type: string format: date-time reimburse: type: boolean expense_type: $ref: '#/components/schemas/ExpenseTypeEnum' paymentType: $ref: '#/components/schemas/PaymentMethodTypeEnum' amount: type: string format: decimal pattern: ^\d{0,12}(?:\.\d{0,2})?$ nullable: true currency_rate_final: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,6})?$ exchange_rate_override: type: boolean tax_name: type: string maxLength: 30 tax_percentage: type: string format: decimal pattern: ^\d{0,8}(?:\.\d{0,8})?$ tax_amount: type: string format: decimal pattern: ^\d{0,12}(?:\.\d{0,2})?$ nullable: true tax_is_inclusive: type: boolean notes: type: string nullable: true maxLength: 500 attachment: type: string active: type: boolean last_changed_by: title: Last changed by user type: integer nullable: true creditcard: type: integer nullable: true tax: type: integer nullable: true required: - account - currency_rate_final - expenseReport - expense_type_fields - localCurrency - merchant - tax_percentage - transDate x-konfig-properties: requester: readOnly: true approver: readOnly: true expense_type: minimum: -2147483648 maximum: 2147483647 paymentType: minimum: -2147483648 maximum: 2147483647 ExpenseReportDocs: type: object properties: id: type: integer uuid: type: string ExpenseReportUserSummaryDocs: 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 position: type: string nullable: true maxLength: 100 profile_image: type: string nullable: true approval_delegatee: allOf: - $ref: '#/components/schemas/ApprovalDelegateeDocs' nullable: true type: object expected_return_date: type: string format: date readOnly: true required: - approval_delegatee - email ExpenseReportWithUserDocs: type: object properties: id: type: integer uuid: type: string user: $ref: '#/components/schemas/ExpenseReportUserSummaryDocs' required: - id - user - uuid ExpenseTypeEnum: enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer FieldTypeEnum: enum: - t - a - i - f - b - m - d - h type: string FlagRead: type: object properties: color: type: string readOnly: true symbol: type: string readOnly: true object_id: type: integer maximum: 4294967295 minimum: 0 format: int64 content_type: type: integer nullable: true required: - object_id FulfilmentStatusEnum: enum: - empty - partial - full type: string InviteFunctionalUserRequest: type: object properties: email: type: string format: email minLength: 1 send_invitation_email: type: boolean default: true first_name: type: string default: '' last_name: type: string default: '' phone: type: string default: '' position: type: string default: '' role_id: type: integer minimum: 0 default: 0 all_locations: type: boolean default: false locations: type: array items: $ref: '#/components/schemas/LocationIdValidationSerializersRequest' default: [] home_department: type: integer minimum: 0 default: 0 home_location: type: integer minimum: 0 default: 0 required: - email ItemMetadataItemRead: type: object properties: metadata: $ref: '#/components/schemas/BillItemsMetadataDocs' data: type: array items: $ref: '#/components/schemas/ItemReadSerializer_v2' required: - data - metadata ItemReadSerializer_v2: type: object properties: description: type: string maxLength: 1000 id: type: integer readOnly: true orderitem: $ref: '#/components/schemas/OrderItemRead' expense: allOf: - $ref: '#/components/schemas/ExpenseRead' nullable: true type: object bill: type: integer nullable: true vendor: $ref: '#/components/schemas/VendorRead' sku: type: string maxLength: 100 po: $ref: '#/components/schemas/PODocs' unit: type: string maxLength: 30 quantity: title: Received Quantity type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ currency: $ref: '#/components/schemas/Currency' total_cost: type: number format: double readOnly: true received_on: type: string format: date-time readOnly: true packing_slips: type: array items: $ref: '#/components/schemas/Attachment' readOnly: true cost_allocations: type: array items: $ref: '#/components/schemas/CostAllocationRead' archived: type: boolean expense_report: $ref: '#/components/schemas/ExpenseReportDocs' same_unit_cost: type: boolean readOnly: true creditcard_item: allOf: - $ref: '#/components/schemas/CreditCardItemRead' nullable: true type: object is_edited: type: boolean readOnly: true unit_cost_diff_log: allOf: - $ref: '#/components/schemas/UnitCostDiffLogDocs' nullable: true readOnly: true type: object tax_name: type: string maxLength: 30 tax_percentage: type: string format: decimal pattern: ^\d{0,8}(?:\.\d{0,8})?$ nullable: true tax_amount: type: number format: double readOnly: true tax_is_inclusive: type: boolean tax: type: integer nullable: true total_cost_with_tax: type: number format: double readOnly: true shipping_amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ nullable: true unit_cost: type: number format: float readOnly: true custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldValueRead' readOnly: true item_type: type: integer readOnly: true type: type: string readOnly: true bill_by_cost: type: boolean readOnly: true required: - cost_allocations - creditcard_item - currency - description - expense - quantity - vendor x-konfig-properties: orderitem: readOnly: true po: readOnly: true expense_report: readOnly: true LanguageEnum: enum: - 1 type: integer LineItemCustomFieldRequest: description: >- Serializer used when custom fields are provided in a request. E.g JSON request with: "custom_fields": [ { "custom_field_name": "string", "custom_field_value": "string" }, ... ] type: object properties: custom_field_name: type: string minLength: 1 custom_field_value: type: string minLength: 1 required: - custom_field_name - custom_field_value ListBillsMetadataDocs: type: object properties: summary: $ref: '#/components/schemas/BillSummaryDocs' permissions: $ref: '#/components/schemas/PermissionsEditDeleteApprove' pagination: $ref: '#/components/schemas/PaginationDocs' required: - pagination - permissions - summary LocationCreateUpsertRequest: type: object properties: name: type: string minLength: 1 maxLength: 150 url: type: string nullable: true logo: type: string nullable: true currency: type: string minLength: 1 phoneOne: type: string minLength: 1 maxLength: 20 fax: type: string nullable: true maxLength: 20 email: type: string format: email nullable: true maxLength: 254 primary_billing_address: $ref: '#/components/schemas/AddressRequest' primary_shipping_address: $ref: '#/components/schemas/AddressRequest' shipping_addresses: type: array items: $ref: '#/components/schemas/AddressRequest' language: $ref: '#/components/schemas/LanguageEnum' locationTimezone: nullable: true oneOf: - $ref: '#/components/schemas/LocationTimezoneEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' type: integer active: type: boolean external_id: description: External id type: string nullable: true maxLength: 100 required: - currency - name - phoneOne - primary_billing_address - primary_shipping_address - shipping_addresses x-konfig-properties: language: minimum: -2147483648 maximum: 2147483647 LocationIdValidationSerializersRequest: type: object properties: id: type: integer minimum: 1 all_departments: type: boolean default: false departments: type: array items: $ref: '#/components/schemas/DepartmentIdValidationRequest' default: [] required: - id LocationSimple: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 150 headquarter: type: boolean readOnly: true required: - name 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 LocationView: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 150 url: type: string format: uri nullable: true maxLength: 200 logo: type: string currency: $ref: '#/components/schemas/Currency' phoneOne: type: string maxLength: 20 fax: type: string nullable: true maxLength: 20 email: type: string format: email nullable: true maxLength: 254 primary_billing_address: $ref: '#/components/schemas/Address' primary_shipping_address: $ref: '#/components/schemas/Address' shipping_addresses: type: array items: $ref: '#/components/schemas/Address' readOnly: true language: $ref: '#/components/schemas/LanguageEnum' locationTimezone: nullable: true oneOf: - $ref: '#/components/schemas/LocationTimezoneEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' type: integer headquarter: type: boolean readOnly: true department_count: type: integer readOnly: true active: type: boolean external_id: description: External id type: string nullable: true maxLength: 100 required: - currency - name - phoneOne - primary_billing_address - primary_shipping_address x-konfig-properties: language: minimum: -2147483648 maximum: 2147483647 LocationViewSerializerList: type: object properties: metadata: type: object additionalProperties: {} default: {} data: type: array items: $ref: '#/components/schemas/LocationView' required: - data LocationViewSerializerSingleCreate: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/LocationView' required: - data LocationViewSerializerSingleRetrieve: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/LocationView' required: - data MasterLogger: type: object properties: id: type: integer readOnly: true user: $ref: '#/components/schemas/UserSummary' next_approver: $ref: '#/components/schemas/UserSummary' 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: title: Procurify PO Number type: integer nullable: true inventoryItem: type: integer nullable: true stocking_parent: type: integer nullable: true required: - approval_delegation - nextApprover - next_approver - user Nested: type: object properties: description: type: string maxLength: 200 id: type: integer readOnly: true code: type: string maxLength: 50 code_length: type: integer maximum: 2147483647 minimum: -2147483648 account_type: $ref: '#/components/schemas/ExpenseTypeEnum' active: type: boolean parent: type: integer nullable: true required: - code - description x-konfig-properties: account_type: minimum: -2147483648 maximum: 2147483647 NestedVendorRequest: type: object properties: id: type: integer readOnly: true requester: type: string readOnly: true submitted_date: type: string format: date-time next_approver: type: string readOnly: true permissions: type: object additionalProperties: {} readOnly: true required: - submitted_date NestedVendorRequestRequest: type: object properties: submitted_date: type: string format: date-time required: - submitted_date NullEnum: enum: - null type: object OptimizedVendor: type: object properties: id: type: integer readOnly: true name: description: Name of the vendor type: string maxLength: 150 active: type: boolean addressLineOne: title: Address line 1 description: First line of address type: string nullable: true maxLength: 300 addressLineTwo: title: Address line 2 description: Second line of address type: string nullable: true maxLength: 300 postalCode: title: Postal Code description: Postal or Zip code of the vendor type: string nullable: true maxLength: 20 city: description: City of the vendor type: string nullable: true maxLength: 50 state_province: title: State/Province description: State or Province of the vendor type: string nullable: true maxLength: 40 country: description: Country of the vendor type: string nullable: true maxLength: 80 phoneOne: description: Primary phone no. of the vendor type: string nullable: true maxLength: 20 phoneTwo: description: Secondary phone no. of the vendor type: string nullable: true maxLength: 20 fax: description: Fax no. of the vendor type: string nullable: true maxLength: 20 email: type: array items: type: string format: email comments: description: Notes about the vendor type: string nullable: true contact: description: Contact person of the vendor type: string nullable: true maxLength: 50 url: description: Website of the vendor type: string nullable: true maxLength: 200 external_id: description: External id of the vendor type: string nullable: true maxLength: 100 dateModified: type: string format: date-time readOnly: true currency: type: integer nullable: true payment_term_ref: allOf: - $ref: '#/components/schemas/PaymentTerm' nullable: true type: object shipping_term_ref: allOf: - $ref: '#/components/schemas/ShippingTerm' nullable: true type: object payment_method_ref: allOf: - $ref: '#/components/schemas/PaymentMethod' nullable: true type: object shipping_method_ref: allOf: - $ref: '#/components/schemas/ShippingMethod' nullable: true type: object payment_methods: type: array items: $ref: '#/components/schemas/PaymentMethodRead' readOnly: true tax: type: integer nullable: true type: $ref: '#/components/schemas/VendorTypeEnum' default_payment_method: type: integer nullable: true creditcards: type: array items: $ref: '#/components/schemas/CreditCard' readOnly: true is_1099_eligible: title: 1099 Eligible? type: boolean nullable: true overall_score: type: string format: decimal pattern: ^\d{0,2}(?:\.\d{0,3})?$ nullable: true is_auto_email_po_enabled: type: boolean po_pdf_labels: description: Placeholder for a KVStore value type: string maxLength: 200 vendor_request: $ref: '#/components/schemas/NestedVendorRequest' required: - email - name - overall_score - type x-konfig-properties: vendor_request: readOnly: true OptimizedVendorRequest: type: object properties: name: description: Name of the vendor type: string minLength: 1 maxLength: 150 active: type: boolean addressLineOne: title: Address line 1 description: First line of address type: string nullable: true maxLength: 300 addressLineTwo: title: Address line 2 description: Second line of address type: string nullable: true maxLength: 300 postalCode: title: Postal Code description: Postal or Zip code of the vendor type: string nullable: true maxLength: 20 city: description: City of the vendor type: string nullable: true maxLength: 50 state_province: title: State/Province description: State or Province of the vendor type: string nullable: true maxLength: 40 country: description: Country of the vendor type: string nullable: true maxLength: 80 phoneOne: description: Primary phone no. of the vendor type: string nullable: true maxLength: 20 phoneTwo: description: Secondary phone no. of the vendor type: string nullable: true maxLength: 20 fax: description: Fax no. of the vendor type: string nullable: true maxLength: 20 email: type: array items: type: string format: email minLength: 1 comments: description: Notes about the vendor type: string nullable: true contact: description: Contact person of the vendor type: string nullable: true maxLength: 50 url: description: Website of the vendor type: string nullable: true maxLength: 200 external_id: description: External id of the vendor type: string nullable: true maxLength: 100 currency: type: integer nullable: true payment_term_ref: allOf: - $ref: '#/components/schemas/PaymentTermRequest' nullable: true type: object shipping_term_ref: allOf: - $ref: '#/components/schemas/ShippingTermRequest' nullable: true type: object payment_method_ref: allOf: - $ref: '#/components/schemas/PaymentMethodRequest' nullable: true type: object shipping_method_ref: allOf: - $ref: '#/components/schemas/ShippingMethodRequest' nullable: true type: object tax: type: integer nullable: true type: $ref: '#/components/schemas/VendorTypeEnum' default_payment_method: type: integer nullable: true is_1099_eligible: title: 1099 Eligible? type: boolean nullable: true overall_score: type: string format: decimal pattern: ^\d{0,2}(?:\.\d{0,3})?$ nullable: true is_auto_email_po_enabled: type: boolean po_pdf_labels: description: Placeholder for a KVStore value type: string maxLength: 200 required: - email - name - overall_score - type OptimizedVendorSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/OptimizedVendor' required: - data OrderItem: type: object properties: PO: type: array items: title: PO type: integer 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: description: External id of the order item type: string 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: title: Last changed by user type: integer nullable: true 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 po_note: title: Comment type: string 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: title: Procurify PO Number type: integer nullable: true purchaser: type: integer nullable: true quantity: type: string format: decimal pattern: ^\d{0,10}(?:\.\d{0,5})?$ receivedFailQty: title: Received Fail Quantity type: string format: decimal pattern: ^\d{0,10}(?:\.\d{0,5})?$ receivedPassQty: title: Received Pass Quantity type: string format: decimal pattern: ^\d{0,10}(?:\.\d{0,5})?$ 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: $ref: '#/components/schemas/ZeroOneEnum' type: $ref: '#/components/schemas/ZeroOneTwoEnum' blanket: $ref: '#/components/schemas/BlanketOrderItemRead' required: - account - approved_datetime - currency - name - num - pref_vendor - price - quantity - unit x-konfig-properties: receive_method: minimum: 0 maximum: 65535 type: minimum: 0 maximum: 65535 blanket: readOnly: true OrderItemAttachment: type: object properties: id: type: integer readOnly: true attachment: type: string upload_datetime: type: string format: date-time readOnly: true name: type: string maxLength: 100 type: $ref: '#/components/schemas/OrderItemAttachmentTypeEnum' user: type: integer item: type: integer required: - attachment - item - name - user OrderItemAttachmentTypeEnum: enum: - other - invoice - packingslip type: string OrderItemPurchaseEdit: type: object properties: id: type: integer name: type: string maxLength: 255 sku: type: string maxLength: 100 unit: type: string maxLength: 30 quantity: type: string format: decimal pattern: ^\d{0,10}(?:\.\d{0,5})?$ price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ po_note: title: Comment type: string custom_fields: type: array items: type: object additionalProperties: {} tax_amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ nullable: true shipping_amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ nullable: true required: - custom_fields - id - name - price - quantity - unit OrderItemPurchaseEditRequest: type: object properties: id: type: integer name: type: string minLength: 1 maxLength: 255 sku: type: string maxLength: 100 unit: type: string minLength: 1 maxLength: 30 quantity: type: string format: decimal pattern: ^\d{0,10}(?:\.\d{0,5})?$ price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ po_note: title: Comment type: string custom_fields: type: array items: type: object additionalProperties: {} tax_amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ nullable: true shipping_amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ nullable: true required: - custom_fields - id - name - price - quantity - unit OrderItemRead: type: object properties: PO: type: array items: title: PO type: integer PO_line_num: type: integer maximum: 2147483647 minimum: -2147483648 account: $ref: '#/components/schemas/AccountRead' 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: number format: float 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: allOf: - $ref: '#/components/schemas/CatalogItemRead' nullable: true type: object created_at: type: string format: date-time readOnly: true currency: $ref: '#/components/schemas/CurrencySummary' dateInvoiced: type: string format: date-time nullable: true external_id: description: External id of the order item type: string maxLength: 100 hot: type: boolean id: type: integer readOnly: true inventoryItem: type: integer nullable: true is_active: type: boolean item_attachments: type: array items: $ref: '#/components/schemas/Attachment' last_changed_by: title: Last changed by user type: integer nullable: true 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 po_note: title: Comment type: string po_version: type: integer maximum: 2147483647 minimum: -2147483648 pref_vendor: $ref: '#/components/schemas/VendorRead' price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ purchase_order: title: Procurify PO Number type: integer nullable: true purchaser: $ref: '#/components/schemas/UserSummary' quantity: type: number format: float receivedFailQty: type: number format: float receivedPassQty: type: number format: float 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 readOnly: true receive_method: $ref: '#/components/schemas/ZeroOneEnum' type: $ref: '#/components/schemas/ZeroOneTwoEnum' blanket: $ref: '#/components/schemas/BlanketOrderItemRead' comments: type: array items: $ref: '#/components/schemas/Comment' readOnly: true confirmation_status: type: integer nullable: true readOnly: true confirmation_status_description: type: string nullable: true readOnly: true cost_details: allOf: - $ref: '#/components/schemas/CostDetails' nullable: true readOnly: true type: object custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldValueRead' readOnly: true date_required: type: string format: date-time readOnly: true has_sibling_items: type: boolean readOnly: true line_comment: type: string readOnly: true logs: type: array items: $ref: '#/components/schemas/MasterLogger' readOnly: true order_description: type: string readOnly: true order_status: type: integer readOnly: true order_uuid: type: string format: uuid readOnly: true punchout_supplier_icon: type: string readOnly: true nullable: true punchout_supplier_name: type: string readOnly: true nullable: true punchout_system: type: integer nullable: true readOnly: true punchout_vendor_reference: type: integer nullable: true readOnly: true punchout_supplier_can_update_quantity: type: boolean readOnly: true purchase_order_number: type: string readOnly: true purchase_order_uuid: type: string format: uuid readOnly: true purchased_currency_rate: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,6})?$ readOnly: true default: '0.000000' recurrence: allOf: - $ref: '#/components/schemas/RecurringOrderItem' nullable: true type: object requester: $ref: '#/components/schemas/SimpleUserSummary' spend_allocation: type: array items: $ref: '#/components/schemas/AllocationRead' readOnly: true submitted_date: type: string format: date-time readOnly: true taxes: type: array items: $ref: '#/components/schemas/Adjustment' nullable: true required: - account - approved_datetime - approved_quantity - catalog_item - currency - item_attachments - name - num - pref_vendor - price - purchaser - quantity - receivedFailQty - receivedPassQty - recurrence - unit x-konfig-properties: receive_method: minimum: 0 maximum: 65535 type: minimum: 0 maximum: 65535 blanket: readOnly: true requester: readOnly: true OrderItemStatusEnum: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer OrderRead: type: object properties: description: type: string nullable: true 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: $ref: '#/components/schemas/CurrencySummary' 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 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: $ref: '#/components/schemas/OrderStatusEnum' next_approver: $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 has_blanket_order_items: type: boolean readOnly: true required: - branch - dateRequired - department - logs - next_approver - user - uuid x-konfig-properties: currency: readOnly: true status: minimum: -2147483648 maximum: 2147483647 OrderStatusEnum: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 type: integer PODocs: type: object properties: number: type: string id: type: integer uuid: type: string POWithListPurchaseOrderDocs: type: object properties: metadata: $ref: '#/components/schemas/PurchaseOrderListMeta' data: type: array items: $ref: '#/components/schemas/PurchaseOrderDocs' required: - data - metadata PaginatedAccountCodeReadList: 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 data: type: array items: $ref: '#/components/schemas/AccountCodeRead' PaginatedCatalogItemBundleReadList: 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 data: type: array items: $ref: '#/components/schemas/CatalogItemBundleRead' PaginatedCatalogItemReadList: 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 data: type: array items: $ref: '#/components/schemas/CatalogItemRead' PaginatedChartOfAccountsAccountList: 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 data: type: array items: $ref: '#/components/schemas/ChartOfAccountsAccount' PaginatedCompanyPaymentMethodReadList: 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 data: type: array items: $ref: '#/components/schemas/CompanyPaymentMethodRead' PaginatedCurrencyList: 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 data: type: array items: $ref: '#/components/schemas/Currency' PaginatedCustomFieldReadList: 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 data: type: array items: $ref: '#/components/schemas/CustomFieldRead' PaginatedDepartmentReadList: 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 data: type: array items: $ref: '#/components/schemas/DepartmentRead' PaginatedLocationViewSerializerListList: 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 data: type: array items: $ref: '#/components/schemas/LocationViewSerializerList' PaginatedOptimizedVendorList: 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 data: type: array items: $ref: '#/components/schemas/OptimizedVendor' 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 data: type: array items: $ref: '#/components/schemas/OrderItem' 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 data: type: array items: $ref: '#/components/schemas/OrderRead' PaginatedPermissionGroupList: 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 data: type: array items: $ref: '#/components/schemas/PermissionGroup' PaginatedPermissionReadList: 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 data: type: array items: $ref: '#/components/schemas/PermissionRead' PaginatedUserProfileUnoptimizedList: 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 data: type: array items: $ref: '#/components/schemas/UserProfileUnoptimized' PaginatedVendorPaymentMethodReadList: 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 data: type: array items: $ref: '#/components/schemas/VendorPaymentMethodRead' PaginationDocs: type: object properties: count: type: integer next: type: string nullable: true previous: type: string nullable: true page_size: type: integer num_pages: type: integer current_page: type: integer required: - count - current_page - next - num_pages - page_size - previous PatchedOptimizedVendorRequest: type: object properties: name: description: Name of the vendor type: string minLength: 1 maxLength: 150 active: type: boolean addressLineOne: title: Address line 1 description: First line of address type: string nullable: true maxLength: 300 addressLineTwo: title: Address line 2 description: Second line of address type: string nullable: true maxLength: 300 postalCode: title: Postal Code description: Postal or Zip code of the vendor type: string nullable: true maxLength: 20 city: description: City of the vendor type: string nullable: true maxLength: 50 state_province: title: State/Province description: State or Province of the vendor type: string nullable: true maxLength: 40 country: description: Country of the vendor type: string nullable: true maxLength: 80 phoneOne: description: Primary phone no. of the vendor type: string nullable: true maxLength: 20 phoneTwo: description: Secondary phone no. of the vendor type: string nullable: true maxLength: 20 fax: description: Fax no. of the vendor type: string nullable: true maxLength: 20 email: type: array items: type: string format: email minLength: 1 comments: description: Notes about the vendor type: string nullable: true contact: description: Contact person of the vendor type: string nullable: true maxLength: 50 url: description: Website of the vendor type: string nullable: true maxLength: 200 external_id: description: External id of the vendor type: string nullable: true maxLength: 100 currency: type: integer nullable: true payment_term_ref: allOf: - $ref: '#/components/schemas/PaymentTermRequest' nullable: true type: object shipping_term_ref: allOf: - $ref: '#/components/schemas/ShippingTermRequest' nullable: true type: object payment_method_ref: allOf: - $ref: '#/components/schemas/PaymentMethodRequest' nullable: true type: object shipping_method_ref: allOf: - $ref: '#/components/schemas/ShippingMethodRequest' nullable: true type: object tax: type: integer nullable: true type: $ref: '#/components/schemas/VendorTypeEnum' default_payment_method: type: integer nullable: true is_1099_eligible: title: 1099 Eligible? type: boolean nullable: true overall_score: type: string format: decimal pattern: ^\d{0,2}(?:\.\d{0,3})?$ nullable: true is_auto_email_po_enabled: type: boolean po_pdf_labels: description: Placeholder for a KVStore value type: string maxLength: 200 PaymentListRead: type: object properties: id: type: integer readOnly: true bill_payments: type: array items: $ref: '#/components/schemas/BillPaymentDocs' nullable: true readOnly: true payment_method_type: type: integer readOnly: true payment_method: allOf: - $ref: '#/components/schemas/CompanyPaymentMethodRead' nullable: true type: object payment_date: type: string format: date nullable: true amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ total_amount_with_tax: type: string readOnly: true tax_amount: type: string readOnly: true inclusive_tax_amount: type: string readOnly: true exclusive_tax_amount: type: string readOnly: true currency: $ref: '#/components/schemas/Currency' status: $ref: '#/components/schemas/PaymentStatusEnum' ach_number: type: integer readOnly: true next_approver_choices: type: array items: $ref: '#/components/schemas/ApproverRead' readOnly: true required: - currency - payment_method x-konfig-properties: status: minimum: 0 maximum: 4294967295 PaymentMetadataDocs: type: object properties: summary: $ref: '#/components/schemas/PaymentSummaryDocs' permissions: $ref: '#/components/schemas/PermissionsEditDeleteApprove' pagination: $ref: '#/components/schemas/PaginationDocs' required: - pagination - permissions - summary PaymentMetadataPaymentListRead: type: object properties: metadata: $ref: '#/components/schemas/PaymentMetadataDocs' data: type: array items: $ref: '#/components/schemas/PaymentListRead' required: - data - metadata PaymentMethod: type: object properties: description: type: string nullable: true id: type: integer readOnly: true name: type: string maxLength: 100 active: type: boolean required: - name PaymentMethodDocs: type: object properties: id: type: integer readOnly: true vendor: type: integer name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: string currency: $ref: '#/components/schemas/Currency' required: - currency - vendor x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 PaymentMethodRead: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: object additionalProperties: {} currency: $ref: '#/components/schemas/Currency' required: - currency - data x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 PaymentMethodReadRequest: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: object additionalProperties: {} currency: $ref: '#/components/schemas/CurrencyRequest' required: - currency - data x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 PaymentMethodRequest: type: object properties: description: type: string nullable: true name: type: string minLength: 1 maxLength: 100 active: type: boolean required: - name PaymentMethodTypeEnum: enum: - 0 - 1 - 2 - 3 - 4 type: integer PaymentSimpleDocs: type: object properties: id: type: integer readOnly: true user: title: Payment User type: integer approver: title: Current Approver type: integer nullable: true status: $ref: '#/components/schemas/PaymentStatusEnum' currency: type: integer amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ payment_method: type: integer nullable: true payment_date: type: string format: date nullable: true memo: type: string maxLength: 255 reference_number: type: string maxLength: 255 is_processed: type: boolean required: - currency - user x-konfig-properties: status: minimum: 0 maximum: 4294967295 PaymentStatusEnum: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 type: integer PaymentSummaryDocs: type: object properties: total_cost: type: number format: float required: - total_cost PaymentTerm: type: object properties: description: type: string nullable: true id: type: integer readOnly: true name: type: string maxLength: 100 active: type: boolean required: - name PaymentTermRequest: type: object properties: description: type: string nullable: true name: type: string minLength: 1 maxLength: 100 active: type: boolean required: - name PendingApprovalsCountDocs: type: object properties: order: type: integer expense: type: integer travel: type: integer bill: type: integer payment: type: integer required: - bill - expense - order - payment - travel PermissionGroup: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 150 user_count: type: integer readOnly: true permissions: type: array items: $ref: '#/components/schemas/PermissionRead' readOnly: true type: type: integer required: - name - type PermissionRead: type: object properties: id: type: integer readOnly: true codename: type: string maxLength: 100 required: - codename PermissionsApprove: type: object properties: can_approve: type: boolean PermissionsEditDelete: type: object properties: can_edit: type: boolean can_delete: type: boolean required: - can_delete - can_edit PermissionsEditDeleteApprove: type: object properties: can_edit: type: boolean can_delete: type: boolean can_approve: type: boolean required: - can_approve - can_delete - can_edit PriceModifierDocs: type: object properties: value: type: number format: float type: $ref: '#/components/schemas/PriceModifierDocsTypeEnum' required: - type - value PriceModifierDocsTypeEnum: enum: - amount - percentage type: string ProcurifyDomain: type: object properties: subdomain: type: string maxLength: 200 name: type: string maxLength: 300 required: - name - subdomain PunchOutReadDocs: type: object properties: id: type: integer name: type: string required: - id - name PurchaseOrderBillingHistory: type: object properties: id: type: integer number: type: string has_unbilled_unreceived_items: type: boolean items: type: array items: $ref: '#/components/schemas/PurchaseOrderBillingHistoryItem' required: - has_unbilled_unreceived_items - id - items - number PurchaseOrderBillingHistoryItem: type: object properties: id: type: integer billed_qty: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ default: '0.00000000' received_qty: type: string format: decimal pattern: ^\d{0,10}(?:\.\d{0,5})?$ default: '0.00000' required: - id PurchaseOrderBillingHistorySerializerList: type: object properties: metadata: type: object additionalProperties: {} default: {} data: type: array items: $ref: '#/components/schemas/PurchaseOrderBillingHistory' required: - data PurchaseOrderContract: type: object properties: id: type: integer uuid: type: string name: type: string required: - id - uuid PurchaseOrderCountsBreakdown: type: object properties: all: type: integer open: type: integer partial: type: integer closed: type: integer cancelled: type: integer page: type: integer required: - all - cancelled - closed - open - page - partial PurchaseOrderCountsMeta: type: object properties: purchased: $ref: '#/components/schemas/PurchaseOrderCountsBreakdown' receivable: $ref: '#/components/schemas/PurchaseOrderCountsBreakdown' PurchaseOrderDetail: type: object properties: version: type: integer maximum: 2147483647 minimum: -2147483648 number: type: string readOnly: true uuid: type: string format: uuid purchaser: $ref: '#/components/schemas/UserSummary' procurify_PO: title: Procurify PO Number type: integer readOnly: true PO_Num: title: PO Number type: string nullable: true maxLength: 30 date: title: PO Date type: string format: date-time readOnly: true buyer_name: type: string maxLength: 100 buyer_contact: type: string maxLength: 100 buyer_addressLineOne: title: Address line type: string maxLength: 300 buyer_postalCode: title: Postal Code type: string maxLength: 20 buyer_city: type: string maxLength: 50 buyer_state_province: title: State/Province type: string maxLength: 40 buyer_country: title: Country type: string maxLength: 80 buyer_address: $ref: '#/components/schemas/AddressSummary' receiver_name: type: string maxLength: 100 receiver_contact: type: string maxLength: 100 receiver_addressLineOne: title: Address line type: string maxLength: 300 receiver_postalCode: title: Postal Code type: string maxLength: 20 receiver_city: type: string maxLength: 50 receiver_state_province: title: State/Province type: string maxLength: 40 receiver_country: title: Country type: string maxLength: 80 receiver_address: $ref: '#/components/schemas/AddressSummary' pref_vendor: $ref: '#/components/schemas/VendorRead' vendor_name: type: string nullable: true maxLength: 150 vendor_contact: type: string nullable: true maxLength: 100 vendor_addressLineOne: title: Address line type: string nullable: true maxLength: 300 vendor_postalCode: title: Postal Code type: string nullable: true maxLength: 20 vendor_city: type: string nullable: true maxLength: 50 vendor_state_province: title: State/Province type: string nullable: true maxLength: 40 vendor_country: title: Country type: string nullable: true maxLength: 80 payment_terms: type: string maxLength: 100 shipping_terms: type: string maxLength: 100 shipping_method: $ref: '#/components/schemas/ShippingMethod' promise_date: type: string format: date-time subtotal: type: string format: decimal pattern: ^\d{0,17}(?:\.\d{0,2})?$ freight: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true tax: $ref: '#/components/schemas/PriceModifierDocs' discount: $ref: '#/components/schemas/PriceModifierDocs' other: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true total: title: Total Cost type: string format: decimal pattern: ^\d{0,17}(?:\.\d{0,2})?$ comment: title: Notes type: string nullable: true purchased_currency: $ref: '#/components/schemas/CurrencySummary' purchased_currency_rate: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,6})?$ nullable: true active: type: boolean state: nullable: true minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/PurchaseOrderStateEnum' - $ref: '#/components/schemas/NullEnum' type: integer fulfilment_status: $ref: '#/components/schemas/FulfilmentStatusEnum' disclaimer_description: type: string nullable: true maxLength: 100 disclaimer_text: type: string nullable: true recorded_date: type: string format: date-time nullable: true closed_date: type: string format: date-time nullable: true last_modified: type: string format: date-time readOnly: true staged_for_export: type: boolean item_count: type: integer readOnly: true most_recent_version: type: integer maximum: 2147483647 minimum: -2147483648 readOnly: true punchout_system: type: integer nullable: true readOnly: true purchase_agreement: type: integer nullable: true readOnly: true purchase_agreement_status: allOf: - $ref: '#/components/schemas/ExpenseTypeEnum' readOnly: true nullable: true type: object punchout_vendor_reference: type: integer nullable: true readOnly: true punchout_supplier_icon: type: string nullable: true readOnly: true punchout_supplier_name: type: string nullable: true readOnly: true has_blanket_order_items: type: boolean readOnly: true expiry_date: type: string format: date-time nullable: true contract: $ref: '#/components/schemas/PurchaseOrderContract' order_items: type: array items: $ref: '#/components/schemas/PurchaseOrderLineItemRead' creditcard_is_editable: type: boolean custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldValueRead' readOnly: true creditcard: allOf: - $ref: '#/components/schemas/CreditCardRead' nullable: true type: object payment_term: $ref: '#/components/schemas/PaymentTerm' shipping_term: $ref: '#/components/schemas/ShippingTerm' cost_details: allOf: - $ref: '#/components/schemas/CostDetails' nullable: true readOnly: true type: object required: - buyer_address - buyer_addressLineOne - buyer_city - buyer_contact - buyer_country - buyer_name - buyer_postalCode - contract - creditcard - creditcard_is_editable - order_items - payment_term - payment_terms - pref_vendor - promise_date - purchased_currency - purchaser - receiver_address - receiver_addressLineOne - receiver_city - receiver_contact - receiver_country - receiver_name - receiver_postalCode - shipping_method - shipping_term - shipping_terms - subtotal - total - uuid x-konfig-properties: tax: readOnly: true discount: readOnly: true PurchaseOrderDetailSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/PurchaseOrderDetail' required: - data PurchaseOrderDocs: type: object properties: version: type: integer maximum: 2147483647 minimum: -2147483648 number: type: string readOnly: true uuid: type: string format: uuid purchaser: $ref: '#/components/schemas/UserSummary' procurify_PO: title: Procurify PO Number type: integer readOnly: true PO_Num: title: PO Number type: string nullable: true maxLength: 30 date: title: PO Date type: string format: date-time readOnly: true buyer_name: type: string maxLength: 100 buyer_contact: type: string maxLength: 100 buyer_addressLineOne: title: Address line type: string maxLength: 300 buyer_postalCode: title: Postal Code type: string maxLength: 20 buyer_city: type: string maxLength: 50 buyer_state_province: title: State/Province type: string maxLength: 40 buyer_country: title: Country type: string maxLength: 80 buyer_address: $ref: '#/components/schemas/AddressSummary' receiver_name: type: string maxLength: 100 receiver_contact: type: string maxLength: 100 receiver_addressLineOne: title: Address line type: string maxLength: 300 receiver_postalCode: title: Postal Code type: string maxLength: 20 receiver_city: type: string maxLength: 50 receiver_state_province: title: State/Province type: string maxLength: 40 receiver_country: title: Country type: string maxLength: 80 receiver_address: $ref: '#/components/schemas/AddressSummary' pref_vendor: $ref: '#/components/schemas/VendorRead' vendor_name: type: string nullable: true maxLength: 150 vendor_contact: type: string nullable: true maxLength: 100 vendor_addressLineOne: title: Address line type: string nullable: true maxLength: 300 vendor_postalCode: title: Postal Code type: string nullable: true maxLength: 20 vendor_city: type: string nullable: true maxLength: 50 vendor_state_province: title: State/Province type: string nullable: true maxLength: 40 vendor_country: title: Country type: string nullable: true maxLength: 80 payment_terms: type: string maxLength: 100 shipping_terms: type: string maxLength: 100 shipping_method: title: Ship Via type: string maxLength: 100 promise_date: type: string format: date-time subtotal: type: string format: decimal pattern: ^\d{0,17}(?:\.\d{0,2})?$ freight: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true tax: $ref: '#/components/schemas/PriceModifierDocs' discount: $ref: '#/components/schemas/PriceModifierDocs' other: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true total: title: Total Cost type: string format: decimal pattern: ^\d{0,17}(?:\.\d{0,2})?$ comment: title: Notes type: string nullable: true purchased_currency: $ref: '#/components/schemas/CurrencySummary' purchased_currency_rate: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,6})?$ nullable: true active: type: boolean state: nullable: true minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/PurchaseOrderStateEnum' - $ref: '#/components/schemas/NullEnum' type: integer fulfilment_status: $ref: '#/components/schemas/FulfilmentStatusEnum' disclaimer_description: type: string nullable: true maxLength: 100 disclaimer_text: type: string nullable: true recorded_date: type: string format: date-time nullable: true closed_date: type: string format: date-time nullable: true last_modified: type: string format: date-time readOnly: true staged_for_export: type: boolean item_count: type: integer readOnly: true most_recent_version: type: integer maximum: 2147483647 minimum: -2147483648 readOnly: true punchout_system: type: integer nullable: true readOnly: true purchase_agreement: type: integer nullable: true readOnly: true purchase_agreement_status: allOf: - $ref: '#/components/schemas/ExpenseTypeEnum' readOnly: true nullable: true type: object punchout_vendor_reference: type: integer nullable: true readOnly: true punchout_supplier_icon: type: string nullable: true readOnly: true punchout_supplier_name: type: string nullable: true readOnly: true has_blanket_order_items: type: boolean readOnly: true expiry_date: type: string format: date-time nullable: true contract: $ref: '#/components/schemas/PurchaseOrderContract' required: - buyer_address - buyer_addressLineOne - buyer_city - buyer_contact - buyer_country - buyer_name - buyer_postalCode - contract - payment_terms - pref_vendor - promise_date - purchased_currency - purchaser - receiver_address - receiver_addressLineOne - receiver_city - receiver_contact - receiver_country - receiver_name - receiver_postalCode - shipping_method - shipping_terms - subtotal - total - uuid x-konfig-properties: tax: readOnly: true discount: readOnly: true PurchaseOrderLineItemRead: type: object properties: PO: type: array items: title: PO type: integer PO_line_num: type: integer maximum: 2147483647 minimum: -2147483648 account: $ref: '#/components/schemas/AccountRead' 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: number format: float 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: array items: $ref: '#/components/schemas/OrderItemAttachment' nullable: true catalog_item: allOf: - $ref: '#/components/schemas/CatalogItemRead' nullable: true type: object created_at: type: string format: date-time readOnly: true currency: $ref: '#/components/schemas/CurrencySummary' dateInvoiced: type: string format: date-time nullable: true external_id: description: External id of the order item type: string maxLength: 100 hot: type: boolean id: type: integer readOnly: true inventoryItem: type: integer nullable: true is_active: type: boolean item_attachments: type: array items: $ref: '#/components/schemas/Attachment' last_changed_by: title: Last changed by user type: integer nullable: true 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 po_note: title: Comment type: string po_version: type: integer maximum: 2147483647 minimum: -2147483648 pref_vendor: $ref: '#/components/schemas/VendorRead' price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ purchase_order: title: Procurify PO Number type: integer nullable: true purchaser: $ref: '#/components/schemas/UserSummary' quantity: type: number format: float receivedFailQty: type: number format: float receivedPassQty: type: number format: float 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 readOnly: true receive_method: $ref: '#/components/schemas/ZeroOneEnum' type: $ref: '#/components/schemas/ZeroOneTwoEnum' blanket: $ref: '#/components/schemas/BlanketOrderItemRead' comments: type: array items: $ref: '#/components/schemas/Comment' readOnly: true confirmation_status: type: integer nullable: true readOnly: true confirmation_status_description: type: string nullable: true readOnly: true cost_details: allOf: - $ref: '#/components/schemas/CostDetails' nullable: true readOnly: true type: object custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldValueRead' readOnly: true date_required: type: string format: date-time readOnly: true has_sibling_items: type: boolean readOnly: true line_comment: type: string readOnly: true logs: type: array items: $ref: '#/components/schemas/MasterLogger' readOnly: true order_description: type: string readOnly: true order_status: type: integer readOnly: true order_uuid: type: string format: uuid readOnly: true punchout_supplier_icon: type: string readOnly: true nullable: true punchout_supplier_name: type: string readOnly: true nullable: true punchout_system: type: integer nullable: true readOnly: true punchout_vendor_reference: type: integer nullable: true readOnly: true punchout_supplier_can_update_quantity: type: boolean readOnly: true purchase_order_number: type: string readOnly: true purchase_order_uuid: type: string format: uuid readOnly: true purchased_currency_rate: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,6})?$ readOnly: true default: '0.000000' recurrence: allOf: - $ref: '#/components/schemas/RecurringOrderItem' nullable: true type: object requester: $ref: '#/components/schemas/SimpleUserSummary' spend_allocation: type: array items: $ref: '#/components/schemas/AllocationRead' readOnly: true submitted_date: type: string format: date-time readOnly: true taxes: type: array items: $ref: '#/components/schemas/Adjustment' nullable: true receive_log_count: type: integer readOnly: true approval_history: type: array items: $ref: '#/components/schemas/MasterLogger' readOnly: true flags: type: array items: $ref: '#/components/schemas/FlagRead' readOnly: true required: - account - approved_datetime - approved_quantity - attachments - catalog_item - currency - item_attachments - name - num - pref_vendor - price - purchaser - quantity - receivedFailQty - receivedPassQty - recurrence - unit x-konfig-properties: receive_method: minimum: 0 maximum: 65535 type: minimum: 0 maximum: 65535 blanket: readOnly: true requester: readOnly: true PurchaseOrderListMeta: type: object properties: counts: $ref: '#/components/schemas/PurchaseOrderCountsMeta' pagination: $ref: '#/components/schemas/PaginationDocs' required: - counts - pagination PurchaseOrderRead: type: object properties: number: type: string readOnly: true uuid: type: string format: uuid purchaser: $ref: '#/components/schemas/SimpleUserSummary' vendor_name: type: string nullable: true maxLength: 150 required: - purchaser - uuid PurchaseOrderReadDocs: type: object properties: version: type: integer maximum: 2147483647 minimum: -2147483648 id: type: integer PO_Num: title: PO Number type: string nullable: true maxLength: 30 date: title: PO Date type: string format: date-time readOnly: true discount: $ref: '#/components/schemas/PriceModifierDocs' freight: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true fulfilment_status: $ref: '#/components/schemas/FulfilmentStatusEnum' item_count: type: integer readOnly: true last_modified: type: string format: date-time readOnly: true number: type: string other: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true pref_vendor: $ref: '#/components/schemas/SimpleVendor' procurify_PO: title: Procurify PO Number type: integer readOnly: true promise_date: type: string format: date-time punchout_system: type: integer nullable: true readOnly: true purchase_agreement: type: integer nullable: true purchase_agreement_status: allOf: - $ref: '#/components/schemas/ExpenseTypeEnum' readOnly: true nullable: true type: object purchased_currency: $ref: '#/components/schemas/SimpleCurrency' purchased_currency_rate: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,6})?$ nullable: true purchaser: $ref: '#/components/schemas/SimpleUser' state: nullable: true minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/PurchaseOrderStateEnum' - $ref: '#/components/schemas/NullEnum' type: integer subtotal: type: string format: decimal pattern: ^\d{0,17}(?:\.\d{0,2})?$ total: title: Total Cost type: string format: decimal pattern: ^\d{0,17}(?:\.\d{0,2})?$ uuid: type: string format: uuid punchout_items_rejected: type: boolean readOnly: true total_amount: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,2})?$ currency: type: string default: '' email_status: type: string nullable: true maxLength: 50 email_status_updated_at: type: string format: date-time nullable: true punchout_supplier_name: type: string nullable: true readOnly: true punchout_supplier_icon: type: string nullable: true readOnly: true punchout_vendor_reference: type: integer nullable: true readOnly: true has_blanket_order_items: type: boolean readOnly: true expiry_date: type: string format: date-time nullable: true required: - id - number - pref_vendor - promise_date - purchased_currency - purchaser - subtotal - total - total_amount - uuid x-konfig-properties: discount: readOnly: true PurchaseOrderReadDocsSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/PurchaseOrderReadDocs' required: - data PurchaseOrderStateEnum: enum: - 0 - 1 - 3 - 4 - 5 type: integer PurchaseOrderUpdate: type: object properties: version: type: integer order_items: type: array items: $ref: '#/components/schemas/OrderItemPurchaseEdit' PO_Num: title: PO Number type: string nullable: true maxLength: 30 buyer_name: type: string maxLength: 100 buyer_contact: type: string maxLength: 100 buyer_addressLineOne: title: Address line type: string maxLength: 300 buyer_postalCode: title: Postal Code type: string maxLength: 20 buyer_city: type: string maxLength: 50 buyer_state_province: title: State/Province type: string maxLength: 40 buyer_country: title: Country type: string maxLength: 80 buyer_address: type: integer comment: title: Notes type: string nullable: true receiver_name: type: string maxLength: 100 receiver_contact: type: string maxLength: 100 receiver_addressLineOne: title: Address line type: string maxLength: 300 receiver_postalCode: title: Postal Code type: string maxLength: 20 receiver_city: type: string maxLength: 50 receiver_state_province: title: State/Province type: string maxLength: 40 receiver_country: title: Country type: string maxLength: 80 receiver_address: type: integer promise_date: type: string format: date-time freight: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true discount: type: object additionalProperties: {} tax: type: object additionalProperties: {} other: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true disclaimer_description: type: string nullable: true maxLength: 100 disclaimer_text: type: string nullable: true payment_term_ref: type: integer nullable: true shipping_term_ref: type: integer nullable: true payment_method_ref: type: integer nullable: true shipping_method_ref: type: integer nullable: true creditcard: type: integer nullable: true expiry_date: type: string format: date-time nullable: true contract: type: integer nullable: true required: - buyer_address - buyer_addressLineOne - buyer_city - buyer_contact - buyer_country - buyer_name - buyer_postalCode - discount - order_items - promise_date - receiver_address - receiver_addressLineOne - receiver_city - receiver_contact - receiver_country - receiver_name - receiver_postalCode - tax - version PurchaseOrderUpdateRequest: type: object properties: version: type: integer order_items: type: array items: $ref: '#/components/schemas/OrderItemPurchaseEditRequest' custom_fields: type: array items: type: object additionalProperties: {} writeOnly: true default: [] PO_Num: title: PO Number type: string nullable: true maxLength: 30 buyer_name: type: string minLength: 1 maxLength: 100 buyer_contact: type: string minLength: 1 maxLength: 100 buyer_addressLineOne: title: Address line type: string minLength: 1 maxLength: 300 buyer_postalCode: title: Postal Code type: string minLength: 1 maxLength: 20 buyer_city: type: string minLength: 1 maxLength: 50 buyer_state_province: title: State/Province type: string maxLength: 40 buyer_country: title: Country type: string minLength: 1 maxLength: 80 buyer_address: type: integer comment: title: Notes type: string nullable: true receiver_name: type: string minLength: 1 maxLength: 100 receiver_contact: type: string minLength: 1 maxLength: 100 receiver_addressLineOne: title: Address line type: string minLength: 1 maxLength: 300 receiver_postalCode: title: Postal Code type: string minLength: 1 maxLength: 20 receiver_city: type: string minLength: 1 maxLength: 50 receiver_state_province: title: State/Province type: string maxLength: 40 receiver_country: title: Country type: string minLength: 1 maxLength: 80 receiver_address: type: integer promise_date: type: string format: date-time freight: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true discount: type: object additionalProperties: {} tax: type: object additionalProperties: {} other: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,6})?$ nullable: true disclaimer_description: type: string nullable: true maxLength: 100 disclaimer_text: type: string nullable: true payment_term_ref: type: integer nullable: true shipping_term_ref: type: integer nullable: true payment_method_ref: type: integer nullable: true shipping_method_ref: type: integer nullable: true creditcard: type: integer nullable: true expiry_date: type: string format: date-time nullable: true contract: type: integer nullable: true required: - buyer_address - buyer_addressLineOne - buyer_city - buyer_contact - buyer_country - buyer_name - buyer_postalCode - discount - order_items - promise_date - receiver_address - receiver_addressLineOne - receiver_city - receiver_contact - receiver_country - receiver_name - receiver_postalCode - tax - version PurchaseOrderUpdateSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/PurchaseOrderUpdate' required: - data RecurringOrderItem: type: object properties: id: type: integer readOnly: true start_date: type: string format: date frequency: $ref: '#/components/schemas/ZeroOneEnum' duration: $ref: '#/components/schemas/ZeroOneEnum' duration_quantity: type: integer maximum: 4294967295 minimum: 1 format: int64 recurring_price: type: string format: decimal pattern: ^\d{0,13}(?:\.\d{0,8})?$ periods_count: type: integer readOnly: true required: - duration - duration_quantity - frequency - recurring_price x-konfig-properties: frequency: minimum: 0 maximum: 4294967295 duration: minimum: 0 maximum: 4294967295 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 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 RequisitionRead: type: object properties: uuid: type: string format: uuid readOnly: true RequisitionReadSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/RequisitionRead' required: - data RoleEnum: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: integer SessionCreate: type: object properties: creditcard: title: Credit Card type: integer balance: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,2})?$ statement_date: type: string format: date-time nullable: true required: - creditcard SetupStageEnum: enum: - COMP - DEPT - USER - COA - BDGT - APPR - FIN type: string ShippingMethod: type: object properties: description: type: string nullable: true id: type: integer readOnly: true name: type: string maxLength: 100 active: type: boolean required: - name ShippingMethodRequest: type: object properties: description: type: string nullable: true name: type: string minLength: 1 maxLength: 100 active: type: boolean required: - name ShippingTerm: type: object properties: description: type: string nullable: true id: type: integer readOnly: true name: type: string maxLength: 100 active: type: boolean required: - name ShippingTermRequest: type: object properties: description: type: string nullable: true name: type: string minLength: 1 maxLength: 100 active: type: boolean required: - name SimpleAPVendor: type: object properties: id: type: integer readOnly: true name: description: Name of the vendor type: string maxLength: 150 required: - name SimpleBill: type: object properties: version: type: integer maximum: 4294967295 minimum: 0 format: int64 id: type: integer readOnly: true status: $ref: '#/components/schemas/BillStatusEnum' locked: type: boolean readOnly: true currency: $ref: '#/components/schemas/SimpleCurrency' uuid: type: string format: uuid items: type: array items: type: integer readOnly: true vendor: $ref: '#/components/schemas/SimpleAPVendor' due_date: title: Bill Due Date type: string format: date-time nullable: true total_cost_with_tax: type: number format: float readOnly: true invoice_date: title: Bill Invoice Date type: string format: date-time nullable: true next_approver_choices: type: array items: $ref: '#/components/schemas/ApproverRead' nullable: true readOnly: true last_export_user: $ref: '#/components/schemas/SimpleUserProfile' last_modified_datetime: title: Last Modified type: string format: date-time readOnly: true last_export_date: type: string format: date readOnly: true submitted_date: type: string format: date-time nullable: true gl_post_date: type: string format: date-time nullable: true invoice_number: type: string maxLength: 50 group: type: integer readOnly: true nullable: true type: $ref: '#/components/schemas/ZeroOneTwoEnum' user: $ref: '#/components/schemas/SimpleUser' approver: allOf: - $ref: '#/components/schemas/BillListViewApproverUserDocs' nullable: true readOnly: true type: object past_due: type: boolean readOnly: true payment_uuid: type: string format: uuid nullable: true invoice_uuid: type: string readOnly: true required: - currency - user - uuid - vendor x-konfig-properties: status: minimum: 0 maximum: 4294967295 last_export_user: readOnly: true type: minimum: 0 maximum: 4294967295 SimpleCurrency: 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})?$ required: - name - rate SimpleDepartment: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 150 location: $ref: '#/components/schemas/SimpleLocation' required: - location - name SimpleExpenseReport: type: object properties: id: type: integer readOnly: true uuid: type: string format: uuid required: - uuid SimpleLocation: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 150 headquarter: type: boolean readOnly: true required: - name SimpleRoleRead: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 150 type: type: integer required: - name - type SimpleUser: 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 profile_image: type: string nullable: true department_name: type: string readOnly: true branch_name: type: string readOnly: true required: - email 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 required: - email SimpleUserSummary: 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 position: type: string nullable: true maxLength: 100 profile_image: type: string nullable: true approval_delegatee: allOf: - $ref: '#/components/schemas/ApprovalDelegateeDocs' nullable: true readOnly: true type: object expected_return_date: type: string format: date readOnly: true required: - email SimpleVendor: type: object properties: id: type: integer readOnly: true name: description: Name of the vendor type: string maxLength: 150 active: type: boolean addressLineOne: title: Address line 1 description: First line of address type: string nullable: true maxLength: 300 addressLineTwo: title: Address line 2 description: Second line of address type: string nullable: true maxLength: 300 postalCode: title: Postal Code description: Postal or Zip code of the vendor type: string nullable: true maxLength: 20 city: description: City of the vendor type: string nullable: true maxLength: 50 state_province: title: State/Province description: State or Province of the vendor type: string nullable: true maxLength: 40 country: description: Country of the vendor type: string nullable: true maxLength: 80 overall_score: type: string readOnly: true is_auto_email_po_enabled: description: >- Represents whether the AutoEmail PO feature is turned on for this Vendor type: boolean required: - name SingleBillMetadataDocs: type: object properties: summary: $ref: '#/components/schemas/BillSummaryDocs' permissions: $ref: '#/components/schemas/PermissionsEditDeleteApprove' required: - permissions - summary SpendAccountRead: type: object properties: id: type: integer readOnly: true account_code: $ref: '#/components/schemas/UnoptimizedAccountCodeserializer' department: $ref: '#/components/schemas/UnoptimizedDepartmentRead' active: type: boolean required: - account_code - department StatementItem: type: object properties: description: type: string maxLength: 255 id: type: integer readOnly: true creditcard: title: Credit Card type: integer statement: type: integer nullable: true match: type: integer nullable: true date: type: string format: date amount: type: string format: decimal pattern: ^\d{0,9}(?:\.\d{0,2})?$ duplicate_of: type: integer nullable: true required: - amount - creditcard TimezoneEnum: enum: - -11 - -10 - -9 - -8 - -7 - -6 - -5 - -4 - -3.5 - -3 - -2 - -1 - 0 - 1 - 2 - 3 - 3.5 - 4 - 4.5 - 5 - 5.5 - 5.75 - 6 - 7 - 8 - 9 - 9.5 - 10 - 11 - 12 type: number UnitCostDiffLogDocs: type: object properties: changed_by: type: string changed_date: type: string original_unit_cost: type: number format: float original_currency_label: type: string UnoptimizedAccountCodeserializer: type: object properties: description: type: string maxLength: 200 id: type: integer readOnly: true code: type: string maxLength: 50 code_length: type: integer maximum: 2147483647 minimum: -2147483648 account_type: $ref: '#/components/schemas/ExpenseTypeEnum' active: type: boolean parent: $ref: '#/components/schemas/Nested' required: - code - description x-konfig-properties: account_type: minimum: -2147483648 maximum: 2147483647 parent: readOnly: true UnoptimizedBranchRead: type: object properties: id: type: integer readOnly: true external_id: description: External id type: string nullable: true maxLength: 100 name: type: string maxLength: 150 url: type: string format: uri nullable: true maxLength: 200 logo: type: string language: $ref: '#/components/schemas/LanguageEnum' 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 timezone: $ref: '#/components/schemas/TimezoneEnum' beginDate: type: string format: date-time readOnly: true ported: type: boolean port_date: type: string format: date-time nullable: true active: type: boolean fields_cache: type: string nullable: true 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 x-konfig-properties: language: minimum: -2147483648 maximum: 2147483647 timezone: maximum: 10000 exclusiveMaximum: true minimum: -10000 exclusiveMinimum: true UnoptimizedDepartmentRead: type: object properties: id: type: integer readOnly: true branch: $ref: '#/components/schemas/UnoptimizedBranchRead' external_id: description: External id type: string nullable: true maxLength: 100 name: type: string maxLength: 150 punchout_email: description: PunchOut Email type: string format: email nullable: true maxLength: 254 active: type: boolean required: - branch - name UserDocs: 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 position: type: string nullable: true maxLength: 100 profile_image: type: string nullable: true approval_delegatee: type: integer nullable: true readOnly: true required: - email UserProfileMe: type: object properties: id: type: integer readOnly: true domains: $ref: '#/components/schemas/DomainSwitching' headquarter_logo: type: string readOnly: true systemaccess_cache: type: object additionalProperties: {} approval_delegatee: allOf: - $ref: '#/components/schemas/ApprovalDelegateeDocs' nullable: true readOnly: true type: object is_approval_delegatee: type: boolean readOnly: true department: $ref: '#/components/schemas/DepartmentLocationRead' 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 pending_invite: type: boolean role: nullable: true minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/RoleEnum' - $ref: '#/components/schemas/NullEnum' type: integer mobile: type: boolean profile_image: type: string nullable: true slack_user_id: type: string maxLength: 50 is_sso_enabled: type: boolean last_changed_by: title: Last changed by user type: integer nullable: true user: type: integer required: - email - systemaccess_cache - user x-konfig-properties: domains: readOnly: true department: readOnly: true UserProfileMeSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/UserProfileMe' required: - data 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 UserProfileUnoptimized: type: object properties: id: type: integer readOnly: true firstName: type: string maxLength: 100 lastName: type: string maxLength: 100 user: type: integer email: type: string format: email maxLength: 254 department: allOf: - $ref: '#/components/schemas/SimpleDepartment' nullable: true type: object location: $ref: '#/components/schemas/SimpleLocation' profile_image: type: string nullable: true is_active: type: boolean phone: type: string nullable: true maxLength: 30 position: type: string nullable: true maxLength: 100 role: $ref: '#/components/schemas/SimpleRoleRead' approval_delegatee: $ref: '#/components/schemas/SimpleUserProfile' pending_approvals_count: $ref: '#/components/schemas/PendingApprovalsCountDocs' expected_return_date: type: string format: date readOnly: true required: - approval_delegatee - department - email - user x-konfig-properties: location: readOnly: true role: readOnly: true pending_approvals_count: readOnly: true UserProfileUnoptimizedSerializerList: type: object properties: metadata: type: object additionalProperties: {} default: {} data: type: array items: $ref: '#/components/schemas/UserProfileUnoptimized' required: - data UserProfileUnoptimizedSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/UserProfileUnoptimized' required: - data UserProfileUpsertRequest: type: object properties: id: type: integer user: type: integer email: type: string format: email minLength: 1 maxLength: 254 firstName: type: string minLength: 1 lastName: type: string minLength: 1 location: type: integer nullable: true department: type: integer nullable: true position: type: string default: '' phone: type: string default: '' profile_image: type: string nullable: true is_sso_enabled: type: boolean default: false mark_for_skip: type: boolean default: false mark_for_delete: type: boolean default: false required: - department - email - firstName - lastName - location 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: title: Last changed by user type: integer nullable: true 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 Vendor: type: object properties: id: type: integer readOnly: true name: description: Name of the vendor type: string maxLength: 150 active: type: boolean addressLineOne: title: Address line 1 description: First line of address type: string nullable: true maxLength: 300 addressLineTwo: title: Address line 2 description: Second line of address type: string nullable: true maxLength: 300 postalCode: title: Postal Code description: Postal or Zip code of the vendor type: string nullable: true maxLength: 20 city: description: City of the vendor type: string nullable: true maxLength: 50 state_province: title: State/Province description: State or Province of the vendor type: string nullable: true maxLength: 40 country: description: Country of the vendor type: string nullable: true maxLength: 80 phoneOne: description: Primary phone no. of the vendor type: string nullable: true maxLength: 20 phoneTwo: description: Secondary phone no. of the vendor type: string nullable: true maxLength: 20 fax: description: Fax no. of the vendor type: string nullable: true maxLength: 20 email: type: array items: type: string format: email comments: description: Notes about the vendor type: string nullable: true contact: description: Contact person of the vendor type: string nullable: true maxLength: 50 url: description: Website of the vendor type: string nullable: true maxLength: 200 external_id: description: External id of the vendor type: string nullable: true maxLength: 100 dateModified: type: string format: date-time readOnly: true currency: type: integer nullable: true payment_term_ref: type: integer nullable: true shipping_term_ref: type: integer nullable: true payment_method_ref: type: integer nullable: true shipping_method_ref: type: integer nullable: true payment_methods: type: array items: $ref: '#/components/schemas/PaymentMethodRead' readOnly: true tax: type: integer nullable: true type: $ref: '#/components/schemas/VendorTypeEnum' default_payment_method: type: integer nullable: true creditcards: type: array items: $ref: '#/components/schemas/CreditCard' readOnly: true is_1099_eligible: title: 1099 Eligible? type: boolean nullable: true overall_score: type: number format: float nullable: true readOnly: true is_auto_email_po_enabled: type: boolean po_pdf_labels: description: Placeholder for a KVStore value type: string maxLength: 200 required: - email - name - type VendorBreakdownDocs: type: object properties: speed: $ref: '#/components/schemas/BreakdownDocs' accuracy: $ref: '#/components/schemas/BreakdownDocs' quality: $ref: '#/components/schemas/BreakdownDocs' cost: $ref: '#/components/schemas/BreakdownDocs' required: - accuracy - cost - quality - speed VendorDetail: type: object properties: id: type: integer readOnly: true name: description: Name of the vendor type: string maxLength: 150 active: type: boolean addressLineOne: title: Address line 1 description: First line of address type: string nullable: true maxLength: 300 addressLineTwo: title: Address line 2 description: Second line of address type: string nullable: true maxLength: 300 postalCode: title: Postal Code description: Postal or Zip code of the vendor type: string nullable: true maxLength: 20 city: description: City of the vendor type: string nullable: true maxLength: 50 state_province: title: State/Province description: State or Province of the vendor type: string nullable: true maxLength: 40 country: description: Country of the vendor type: string nullable: true maxLength: 80 phoneOne: description: Primary phone no. of the vendor type: string nullable: true maxLength: 20 phoneTwo: description: Secondary phone no. of the vendor type: string nullable: true maxLength: 20 fax: description: Fax no. of the vendor type: string nullable: true maxLength: 20 email: type: array items: type: string readOnly: true comments: description: Notes about the vendor type: string nullable: true contact: description: Contact person of the vendor type: string nullable: true maxLength: 50 url: description: Website of the vendor type: string nullable: true maxLength: 200 external_id: description: External id of the vendor type: string nullable: true maxLength: 100 dateModified: type: string format: date-time readOnly: true currency: type: integer nullable: true payment_term_ref: allOf: - $ref: '#/components/schemas/PaymentTerm' nullable: true type: object shipping_term_ref: allOf: - $ref: '#/components/schemas/ShippingTerm' nullable: true type: object payment_method_ref: allOf: - $ref: '#/components/schemas/PaymentMethod' nullable: true type: object shipping_method_ref: allOf: - $ref: '#/components/schemas/ShippingMethod' nullable: true type: object payment_methods: type: array items: $ref: '#/components/schemas/PaymentMethodRead' readOnly: true tax: type: integer nullable: true type: $ref: '#/components/schemas/VendorTypeEnum' default_payment_method: type: integer nullable: true creditcards: type: array items: $ref: '#/components/schemas/CreditCard' readOnly: true is_1099_eligible: title: 1099 Eligible? type: boolean nullable: true overall_score: type: number format: float nullable: true readOnly: true is_auto_email_po_enabled: type: boolean po_pdf_labels: description: Placeholder for a KVStore value type: string maxLength: 200 performance: allOf: - $ref: '#/components/schemas/VendorPerformance' nullable: true readOnly: true type: object vendor_request: $ref: '#/components/schemas/NestedVendorRequest' required: - name - type x-konfig-properties: vendor_request: readOnly: true VendorDetailSerializerSingleCreate: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/VendorDetail' required: - data VendorDetailSerializerSingleRetrieve: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/VendorDetail' required: - data VendorDocs: type: object properties: id: type: integer readOnly: true name: description: Name of the vendor type: string maxLength: 150 required: - name VendorPaymentMethod: type: object properties: id: type: integer readOnly: true vendor: type: integer name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: object additionalProperties: {} currency: type: integer required: - data - vendor x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 VendorPaymentMethodRead: type: object properties: id: type: integer readOnly: true vendor: type: integer name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: object additionalProperties: {} currency: $ref: '#/components/schemas/Currency' required: - currency - data - vendor x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 VendorPaymentMethodRequest: type: object properties: vendor: type: integer name: type: string maxLength: 255 type: $ref: '#/components/schemas/PaymentMethodTypeEnum' data: type: object additionalProperties: {} currency: type: integer required: - data - vendor x-konfig-properties: type: title: Payment Method minimum: 0 maximum: 4294967295 VendorPerformance: type: object properties: overall_score: type: number format: float readOnly: true average_delivery_time: type: string format: decimal pattern: ^\d{0,3}(?:\.\d{0,3})?$ nullable: true readOnly: true breakdown: $ref: '#/components/schemas/VendorBreakdownDocs' x-konfig-properties: breakdown: readOnly: true VendorRead: type: object properties: id: type: integer readOnly: true name: description: Name of the vendor type: string maxLength: 150 active: type: boolean addressLineOne: title: Address line 1 description: First line of address type: string nullable: true maxLength: 300 addressLineTwo: title: Address line 2 description: Second line of address type: string nullable: true maxLength: 300 postalCode: title: Postal Code description: Postal or Zip code of the vendor type: string nullable: true maxLength: 20 city: description: City of the vendor type: string nullable: true maxLength: 50 state_province: title: State/Province description: State or Province of the vendor type: string nullable: true maxLength: 40 country: description: Country of the vendor type: string nullable: true maxLength: 80 phoneOne: description: Primary phone no. of the vendor type: string nullable: true maxLength: 20 phoneTwo: description: Secondary phone no. of the vendor type: string nullable: true maxLength: 20 fax: description: Fax no. of the vendor type: string nullable: true maxLength: 20 email: type: array items: type: string format: email comments: description: Notes about the vendor type: string nullable: true contact: description: Contact person of the vendor type: string nullable: true maxLength: 50 url: description: Website of the vendor type: string nullable: true maxLength: 200 external_id: description: External id of the vendor type: string nullable: true maxLength: 100 dateModified: type: string format: date-time readOnly: true currency: type: integer nullable: true payment_term_ref: allOf: - $ref: '#/components/schemas/PaymentTerm' nullable: true type: object shipping_term_ref: allOf: - $ref: '#/components/schemas/ShippingTerm' nullable: true type: object payment_method_ref: allOf: - $ref: '#/components/schemas/PaymentMethod' nullable: true type: object shipping_method_ref: allOf: - $ref: '#/components/schemas/ShippingMethod' nullable: true type: object payment_methods: type: array items: $ref: '#/components/schemas/PaymentMethodRead' readOnly: true tax: type: integer nullable: true type: $ref: '#/components/schemas/VendorTypeEnum' default_payment_method: type: integer nullable: true creditcards: type: array items: $ref: '#/components/schemas/CreditCard' readOnly: true is_1099_eligible: title: 1099 Eligible? type: boolean nullable: true overall_score: type: number format: float nullable: true readOnly: true is_auto_email_po_enabled: type: boolean po_pdf_labels: description: Placeholder for a KVStore value type: string maxLength: 200 required: - email - name - type VendorSerializerSingle: type: object properties: metadata: type: object additionalProperties: {} default: {} data: $ref: '#/components/schemas/Vendor' required: - data VendorTypeEnum: enum: - 2 - 7 - 3 - 4 - 6 type: integer VersionChoicesDocs: type: object properties: version: type: integer pk: type: integer ZeroOneEnum: enum: - 0 - 1 type: integer ZeroOneTwoEnum: enum: - 0 - 1 - 2 type: integer OauthTokenRequestRequest: type: object properties: client_id: type: string client_secret: type: string audience: type: string grant_type: type: string UsersCreateRequest: type: array items: $ref: '#/components/schemas/InviteFunctionalUserRequest' UsersCreateRequest1: type: array items: $ref: '#/components/schemas/InviteFunctionalUserRequest' UsersCreateRequest2: type: array items: $ref: '#/components/schemas/InviteFunctionalUserRequest' UsersCreateRequest3: type: array items: $ref: '#/components/schemas/InviteFunctionalUserRequest' UsersCreateRequest4: type: array items: $ref: '#/components/schemas/InviteFunctionalUserRequest' OauthTokenRequestResponse: type: object properties: access_token: type: string scope: type: string expires_in: type: number token_type: type: string enum: - Bearer securitySchemes: BasicAuthentication: type: http scheme: basic M2MAuthentication: type: http scheme: bearer bearerFormat: JWT RemoteAuthentication: type: oauth2 flows: authorizationCode: authorizationUrl: https://.procurify.com/oauth/authorize tokenUrl: https://.procurify.com/oauth/token scopes: {} cookieAuth: type: apiKey in: cookie name: sessionid oauth2: type: oauth2 flows: {} tokenAuth: description: Token-based authentication with required prefix "Token" type: apiKey in: header name: Authorization