Basware Vault Archiving API

openapi: 3.2.0
info:
  version: 1.1.1
  title: Open Vault Vault Archiving API
  description: '**Using Basware Vault APIs**

    1.'
servers:
- url: https://api.basware.com/v1
security:
- baswareBasicAuth: []
tags:
- name: Vault Archiving
paths:
  /vaults/{vaultId}/documents:
    post:
      tags:
      - Vault Archiving
      summary: Send the document metadata for archiving and receive pre-signed URL to upload…
      operationId: postArchivedDocument
      parameters:
      - in: path
        name: vaultId
        description: Vault ID to be posted to
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ArchivedDocumentResponse'
        '400':
          description: Invalid request
        '403':
          description: Forbidden
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ArchivedDocument'
        description: Metadata of the document.
        required: true
  /{pre-signed URL}:
    put:
      tags:
      - Vault Archiving
      summary: Upload the document ZIP file to be archived using a pre-signed URL
      operationId: putArchivedDocument
      parameters:
      - in: path
        name: pre-signed URL
        description: URL where to PUT the file. Use the pre-signed URL returned from POST request. Uses a different domain from api.basware.com.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation.
        '400':
          description: Invalid request
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: ZIP archive containing file(s) to be archived related to the document.
                  format: binary
              required:
              - file
  /vaults/{vaultId}/documents/status:
    get:
      tags:
      - Vault Archiving
      summary: Returns the status of archived documents.
      operationId: getArchiveStatuses
      parameters:
      - in: path
        name: vaultId
        description: Vault ID to be checked from
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ArchivedDocumentStatusResponse'
        '400':
          description: Invalid request
        '403':
          description: Forbidden
      deprecated: false
  /vaults/{vaultId}/documents/{bumid}/status:
    get:
      tags:
      - Vault Archiving
      summary: Return archival status a document
      operationId: getArchiveStatusWithID
      parameters:
      - name: bumid
        in: path
        description: Unique identifier of the document. Issued by Basware. BUMID must belong to user.
        required: true
        schema:
          type: string
      - in: path
        name: vaultId
        description: Vault ID to be checked from
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchivedDocumentStatusResponse'
        '400':
          description: Invalid request
        '404':
          description: Not found. Typically returned when no document was found using the bumId.
        '403':
          description: Forbidden
      deprecated: false
components:
  schemas:
    ArchivedDocumentResponse:
      type: object
      properties:
        bumId:
          type: string
          description: Unique identifier of the document. Issued by Basware
          example: 46aa4caf-b373-11ed-bbfc-cfd535abf178
        documentId:
          type: string
          description: Document identifier. For invoice, normally invoice number.
          example: 10003456
        clientUUID:
          type: string
          description: Unique identifier as passed on the request for correlation
          example: 10d96d73-ff7f-49a7-8e8f-a6c7359f4939
        archiveFileURL:
          $ref: '#/components/schemas/ArchiveFileURL'
    ArchivedDocument:
      type: object
      required:
      - clientUUID
      - documentId
      - documentDate
      - documentType
      properties:
        clientUUID:
          type: string
          maxLength: 100
          description: Document identifier created by client. Unique ID in client's namespace. It is returned in the response as a correlation ID. Not to be confused with the documentId (eg invoice number).
          example: 10d96d73-ff7f-49a7-8e8f-a6c7359f4939
        documentType:
          type: string
          description: Specifies document type. Either Invoice, CreditNote, InvoiceSelfBilled or CreditNoteSelfBilled.
          pattern: Invoice|CreditNote|InvoiceSelfBilled|CreditNoteSelfBilled
          example: Invoice
        senderName:
          type: string
          maxLength: 150
          description: Name of the document sender. For invoice, supplier name.
          example: Newey & Eyre (UK) Ltd
        senderIds:
          type: array
          items:
            type: string
          description: 'Array of IDs identifying the sender. Total size of the array should not exceed: 300 chars'
          example:
          - S1001
          - S1002
          - S1003
        recipientName:
          type: string
          maxLength: 150
          description: Name of the document recipient. For invoice, receiving company's name.
          example: Acme Inc.
        recipientIds:
          type: array
          items:
            type: string
          description: 'Array of IDs identifying the recipient. Total size of the array should not exceed: 300 chars'
          example:
          - R1001
          - R1002
          - R1003
        tradingPartner:
          type: string
          maxLength: 150
          description: Name of the document recipient or sender. For invoice, receiving company's name or supplier name.
          example: Acme Inc.
        documentDate:
          type: string
          description: Date of the document. For invoice, normally invoice date. ISO 8601
          example: 2010-11-30 08:39:03+00:00
        documentId:
          type: string
          maxLength: 100
          description: Document identifier. For invoice, normally invoice number. Is not required to be unique but this will be used in search criteria, so it helps if they are easily identifiable using a compound search (documentId + senderId).
          example: 10003456
        currencyCode:
          type: string
          maxLength: 3
          description: 3 digit currency code of the document. ISO 4217
          example: EUR
        buyerReferenceId:
          type: string
          maxLength: 100
          description: An identifier assigned by the Buyer used for internal routing purposes.
          example: buyer@acme.com
        buyerReferenceType:
          type: string
          maxLength: 100
          description: Type of buyerReferenceId. Freetext field. eg. email, name, VAT
          example: email
        amount:
          type: number
          description: Amount of document. For invoice, use net sum.
          example: 1600.09
        flowDirection:
          type: string
          description: Document flow direction. Either sending or receiving.
          pattern: sending|receiving
          example: sending
    ArchiveFileURL:
      type: object
      properties:
        url:
          type: string
          example: https://cipreprod-archivewarm-openapistagings3bucket-503ac9e65ad1.s3.eu-west-1.amazonaws.com/70944116/otlwif/2023/03/03/CZ/U6/46aa4caf-b373-11ed-bbfc-cfd535abf178.zip?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEFUaCWV1LXdlc3QtMSJHMEUCIQDCIc4zFGqvfPoixMy5L55YwXQi94j28XXbOIQ4nUjVcQIgAQ6soIBTE5Oq3wtl1%2BrrgssIz2mNzsvt9UxN3iiijZ8q3AMI7f%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgw0OTM3NjA2MDY4MzAiDGI%2BalWWdyGDfGbq9yqwA%2BGAbXcyOWHLDPDiTdA7F9LVMm5OkNd1OTAwr0VbizgBgD8XYrf0qn6F4cyCNJEw20RqkfhgRUq2LXtMsBAd%2Fx2hwp2qqARdcpFA0thltLxlFIUT2wc03wmnsLrmo7oJUAKfZ6qrH5zK9JKG6fZtjdX9F6uC2TAa16o4vIVMLwrWs3VblSPoU4R5OpPetN7SMCmTiUW%2Fwa%2B2P4OhsWoceKS2H2xxtrnOHFr0bLAl7pXPhmNFh%2F5R2X4X9eFuPMsbEwn0sOVoAAMDJwaok%2Ffi8XwjP8g69bb4Q78txhgc21I9mY3Jm4aO7kvtpx28taczXRCIYnrgkuFbuZSc4MSg3YfEgSdZNLz63KekmOlgYhohvqqopgnZ5c3UURcV%2FjrLlTkg405u56SI%2BOtM7fXl6JC90B7n%2Ffb84LlzCSXbWVjcCBPOXFDYIQdMpzbXyIJPUBx75wIATmV7CKzgg%2FO%2FXlcZ8%2FWC3FJEe0oefsqFa4ifkW9d83ZKrzZXSr2MS3zW22Y8Sh9hOx%2FsMhJnpwY5hzP6K3SIRxnHyqc7rTswWLPBgPSvbpwLzVA9mYlyEf0przCKsN2fBjqeAT7tYKT1IaaGkB0t2X9CNMf2hbtJgyHrYQNS8%2FJ1KVwSahHS3YMuY88ZiGPZnqNdqep8xVUeO1t2tPA7QymHiuz5SYVA2y0Ifaf%2Bs0MKBZwjnFAyXy%2BZQkpkvUFzl20EhOTAYSbjvi%2FAocaKyGiLTdxliZVsnBP8mq0sEIz7rGIOZzWObOfk69qD4nYgis9mrldJHL2Z1DeM9fYyuIBo&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230223T121201Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=ASIAXF5TM6JXFF7XYS77%2F20230223%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=5a824dab54b0d325862d0e036b702fcab8d98e5542ba93e2da67239b72b19a33
    ArchivedDocumentStatusResponse:
      type: object
      properties:
        bumId:
          type: string
          description: Identifier of the archived document.
          example: 46aa4caf-b373-11ed-bbfc-cfd535abf178
        documentId:
          type: string
          description: Document identifier. For invoice, normally invoice number.
          example: 10003456
        clientUUID:
          type: string
          description: Unique identifier as passed on the request for correlation
          example: 10d96d73-ff7f-49a7-8e8f-a6c7359f4939
        lastUpdated:
          type: string
          description: Date and time of the last status update.
          example: 2023-02-23 08:39:03+00:00
        status:
          type: string
          pattern: WaitingForPackageUpload|ArchivingInProgress|ArchivingSuccessful|ArchivingFailed
          description: Status of document archiving.
          example: ArchivingInProgress
        message:
          type: string
          description: Additional status message in exception cases. For example if file is not found in staging area in 15 minutes.
          example: ''
  securitySchemes:
    baswareBasicAuth:
      type: http
      scheme: basic