Vic.ai Attachments API

openapi: 3.2.0
info:
  version: v10.40.4
  contact: {}
  title: Vic.ai Attachments API
  description: '## Introduction


    The Vic.ai API provides a seamless connection between your Enterprise Resource

    Planning (ERP) system and the Vic.ai product suite.'
servers:
- url: https://api.no.stage.vic.ai
  description: staging server, NO
- url: https://api.us.vic.ai
  description: production server, US
- url: https://api.no.vic.ai
  description: production server, NO
security:
- BearerAuth: []
tags:
- name: Attachments
  description: Attachments are original invoice documents that can be processed by Vic.ai.
paths:
  /v0/attachments:
    post:
      description: 'Use this to upload an attachment to Vic.ai. The attachment will be

        created and processing enqueued automatically.


        The response is a 201 with the attachment ID.'
      summary: Upload an attachment
      operationId: uploadAttachment
      tags:
      - Attachments
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '201':
          $ref: '#/components/responses/AttachmentCreatedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /v0/attachments/{id}:
    get:
      description: 'Returns the processing status of an uploaded attachment, and the ids of

        any invoices created from it.


        Processing is asynchronous: a `201` from the upload only confirms the

        file was received and queued. Poll this endpoint to learn whether

        processing completed (`status: processed`) or failed (`status: failed`).'
      summary: Get attachment processing status
      operationId: getAttachmentStatus
      tags:
      - Attachments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The attachment's processing status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                    enum:
                    - processing
                    - processed
                    - failed
                    - ignored
                  error_code:
                    oneOf:
                    - type: 'null'
                    - type: string
                  error_message:
                    oneOf:
                    - type: 'null'
                    - type: string
                  invoice_ids:
                    type: array
                    items:
                      type: string
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    ErrorString:
      type: string
      maxLength: 255
    Attachment:
      type: object
      required:
      - id
      properties:
        id:
          $ref: '#/components/schemas/InternalId'
    InternalId:
      description: The internal id Vic uses for the record.
      type: string
      example: '47'
      readOnly: true
    Error:
      description: 'generic error message in JSON format.  Note the ''code'' field should

        match the HTTP status code of the wrapping HTTP request.

        '
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: integer
          minimum: 100
          maximum: 599
        message:
          $ref: '#/components/schemas/ErrorString'
  responses:
    TooManyRequestsResponse:
      description: HTTP call rate limit exceeded.
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request. Waiting this long guarantees the rate-limit window has reset.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ErrorResponse:
      description: An unexpected error has occurred. Check the body for more details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    AttachmentCreatedResponse:
      description: The shape of the response when an attachment is created.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Attachment'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
x-tagGroups:
- name: Integration
  tags:
  - Authentication
  - Pagination
  - Webhooks
  - Webhook Subscriptions
  - Webhook Events
  - Synchronizing
  - Status
- name: Master Data
  tags:
  - Accounts
  - Dimensions
  - Vendors
  - Vendor Groups
  - Vendor Tags
  - Tags
  - Tax Codes
  - VAT Codes
  - Payment Terms
- name: Organization & Access
  tags:
  - Partners
  - Organizations
  - Companies
  - Users
- name: Invoices & Bills
  tags:
  - Invoices
  - Bills
  - Attachments
  - Invoice Approval Flows
  - Invoice Posting Guide
  - Training Invoices
- name: Purchase Orders
  tags:
  - Purchase Orders
  - Purchase Order Line Items
  - Purchase Order Matching Guide
- name: Payments
  tags:
  - Payment Batches
  - Payment Confirmations
  - Credit Confirmations
- name: Reporting
  tags:
  - CSV Reports
- name: Reference
  tags:
  - Changelog