Venminder (Digital Comply)

Venminder (Digital Comply) VendorSpend API

The VendorSpend API from Venminder (Digital Comply) — 8 operation(s) for vendorspend.

GitHub OpenAPI

Documentation

📖
Documentation
https://developers.venminder.com/318218fb2/p/325101-getting-started

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/venminder-digital-comply/refs/heads/main/openapi/venminder-digital-comply-vendorspend-api-openapi.yml

Other Resources

🔗
SwaggerUI
https://rsd.venminder.com/swagger

OpenAPI Specification

venminder-digital-comply-vendorspend-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Venminder OpenApi BusinessUnit VendorSpend API
  version: v1
security:
- Bearer: []
tags:
- name: VendorSpend
paths:
  /api/v1/SpendAnalysis/CreateBudget:
    post:
      tags:
      - VendorSpend
      summary: Creates a vendor Budget
      parameters:
      - name: cultureCode
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest'
          application/*+xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
  /api/v1/SpendAnalysis/CreateSpendItem:
    post:
      tags:
      - VendorSpend
      summary: Creates a vendor spend item
      parameters:
      - name: cultureCode
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest'
          application/*+xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
  /api/v1/SpendAnalysis/DeleteBudget:
    delete:
      tags:
      - VendorSpend
      summary: Deletes a vendor budget and unlinks all spend items associated with the budget.
      parameters:
      - name: budgetKey
        in: query
        schema:
          type: string
      - name: cultureCode
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
  /api/v1/SpendAnalysis/DeleteSpend:
    delete:
      tags:
      - VendorSpend
      summary: Deletes a vendor spend.
      parameters:
      - name: spendKey
        in: query
        schema:
          type: string
      - name: cultureCode
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
  /api/v1/SpendAnalysis/GetBudgets:
    get:
      tags:
      - VendorSpend
      summary: Provides a list of active budgets for a particular vendor.
      description: Provides a list of active budgets for a particular vendor. This includes the budget key, name, amount, start date, and end date.
      parameters:
      - name: vendorKey
        in: query
        schema:
          type: string
      - name: cultureCode
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.VendorSpend.BudgetResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
  /api/v1/SpendAnalysis/GetSpends:
    get:
      tags:
      - VendorSpend
      summary: Gets all active spend items based on the vendor key.
      description: Returns null for ProductKey if the spend is only linked to the vendor.
      parameters:
      - name: vendorKey
        in: query
        schema:
          type: string
      - name: cultureCode
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.VendorSpend.GetSpendItemsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
  /api/v1/SpendAnalysis/UpdateSpendItem:
    post:
      tags:
      - VendorSpend
      summary: Updates a vendor spend item
      parameters:
      - name: cultureCode
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest'
          application/*+xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest'
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
  /api/v1/SpendAnalysis/UpdateBudget:
    post:
      tags:
      - VendorSpend
      summary: Updates a vendor spend budget
      parameters:
      - name: cultureCode
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest'
          application/*+xml:
            schema:
              $ref: '#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest'
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApi.v1.ErrorResponse'
components:
  schemas:
    OpenApi.v1.VendorSpend.GetSpendItemsResponse:
      title: OpenApi.v1.VendorSpend.GetSpendItemsResponse
      type: object
      properties:
        numberOfSpends:
          type: integer
          format: int32
          readOnly: true
        spends:
          type: array
          items:
            $ref: '#/components/schemas/OpenApi.v1.VendorSpend.SpendItem'
          nullable: true
      additionalProperties: false
      xml:
        name: VendorSpend.GetSpendItemsResponse
    OpenApi.v1.VendorSpend.CreateSpendResponse:
      title: OpenApi.v1.VendorSpend.CreateSpendResponse
      type: object
      properties:
        key:
          type: string
          nullable: true
      additionalProperties: false
      xml:
        name: VendorSpend.CreateSpendResponse
    OpenApi.v1.VendorSpend.BudgetResponse:
      title: OpenApi.v1.VendorSpend.BudgetResponse
      type: object
      properties:
        key:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        amount:
          type: number
          format: double
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
      additionalProperties: false
      xml:
        name: VendorSpend.BudgetResponse
    OpenApi.v1.VendorSpend.UpdateBudgetRequest:
      title: OpenApi.v1.VendorSpend.UpdateBudgetRequest
      type: object
      properties:
        key:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        startDate:
          type: string
          nullable: true
        amount:
          type: string
          nullable: true
      additionalProperties: false
      xml:
        name: VendorSpend.UpdateBudgetRequest
    OpenApi.v1.VendorSpend.CreateBudgetResponse:
      title: OpenApi.v1.VendorSpend.CreateBudgetResponse
      type: object
      properties:
        key:
          type: string
          nullable: true
      additionalProperties: false
      xml:
        name: VendorSpend.CreateBudgetResponse
    OpenApi.v1.ErrorResponse:
      title: OpenApi.v1.ErrorResponse
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        errors:
          type: array
          items:
            $ref: '#/components/schemas/OpenApi.v1.ErrorResource'
          nullable: true
      additionalProperties: false
      xml:
        name: ErrorResponse
    OpenApi.v1.VendorSpend.CreateSpendRequest:
      title: OpenApi.v1.VendorSpend.CreateSpendRequest
      type: object
      properties:
        budgetKey:
          type: string
          nullable: true
        vendorKey:
          type: string
          nullable: true
        productKey:
          type: string
          nullable: true
        invoiceNumber:
          type: string
          nullable: true
        invoiceDate:
          type: string
          nullable: true
        amount:
          type: string
          nullable: true
        notes:
          type: string
          nullable: true
      additionalProperties: false
      xml:
        name: VendorSpend.CreateSpendRequest
    OpenApi.v1.ErrorResource:
      title: OpenApi.v1.ErrorResource
      type: object
      properties:
        resourceKey:
          type: string
          nullable: true
        resourceValue:
          type: string
          nullable: true
        field:
          type: string
          nullable: true
      additionalProperties: false
      xml:
        name: ErrorResource
    OpenApi.v1.VendorSpend.SpendItem:
      title: OpenApi.v1.VendorSpend.SpendItem
      type: object
      properties:
        key:
          type: string
          nullable: true
        budgetKey:
          type: string
          nullable: true
        budgetName:
          type: string
          nullable: true
        vendorKey:
          type: string
          nullable: true
        productKey:
          type: string
          nullable: true
        invoiceNumber:
          type: string
          nullable: true
        invoiceDate:
          type: string
          format: date-time
        amount:
          type: number
          format: double
        notes:
          type: string
          nullable: true
      additionalProperties: false
      xml:
        name: VendorSpend.SpendItem
    OpenApi.v1.VendorSpend.CreateBudgetRequest:
      title: OpenApi.v1.VendorSpend.CreateBudgetRequest
      type: object
      properties:
        name:
          type: string
          nullable: true
        startDate:
          type: string
          nullable: true
        amount:
          type: string
          nullable: true
        vendorKey:
          type: string
          nullable: true
      additionalProperties: false
      xml:
        name: VendorSpend.CreateBudgetRequest
    OpenApi.v1.VendorSpend.UpdateSpendRequest:
      title: OpenApi.v1.VendorSpend.UpdateSpendRequest
      type: object
      properties:
        key:
          type: string
          nullable: true
        vendorKey:
          type: string
          nullable: true
        budgetKey:
          type: string
          nullable: true
        productKey:
          type: string
          nullable: true
        invoiceNumber:
          type: string
          nullable: true
        invoiceDate:
          type: string
          nullable: true
        amount:
          type: string
          nullable: true
        notes:
          type: string
          nullable: true
      additionalProperties: false
      xml:
        name: VendorSpend.UpdateSpendRequest
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert access token with Bearer into field eg. Bearer eyJhbGciOiJSUzI1Ni and click authorize.
      name: Authorization
      in: header