Basware Directory France lookup API

openapi: 3.2.0
info:
  title: Basware OAUTH2 authentication APIs AccountingDocuments Directory France lookup API
  description: "**Using OAUTH2.0 authentication:**\n\nGet API access token from api.basware.com/tokens\n1. Using client id and client secret, which you can obtain from Basware. \n2. Specify which APIs can be accessed by using the token e.g. Read only access to vendors API only (these are called scopes). Available scopes are listed at <https://developer.basware.com/api/p2p/manual#AccessRights>. \n3. Each token has an expiration time, until which it can be used to call APIs.\n\nWhen using OAUTH2 authentication, you need to pass the OAUTH2 authentication token when calling Basware API endpoints. Available Basware API operations are documented at <https://api.basware.com/swagger>. \n\nSee the Basware API developer site at <https://developer.basware.com/api/p2p/manual#Authentication> for more details on API authentication."
  version: 1.0.0
  x-logo:
    url: https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png
servers:
- url: https://api.basware.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Directory France lookup
paths:
  /directory/fr:
    get:
      tags:
      - Directory France lookup
      summary: Search
      operationId: search_directory_fr_get
      parameters:
      - name: siren
        in: query
        required: false
        schema:
          type: string
          minLength: 9
          maxLength: 9
          pattern: ^[0-9]{9}$
          description: SIREN number, min_length=9, max_length=9 regex=^[0-9]{9}$
          title: Siren
        description: SIREN number, min_length=9, max_length=9 regex=^[0-9]{9}$
      - name: siret
        in: query
        required: false
        schema:
          type: string
          minLength: 14
          maxLength: 14
          pattern: ^[0-9]{14}$
          description: SIRET number, min_length=14, max_length=14, regex=^[0-9]{14}$
          title: Siret
        description: SIRET number, min_length=14, max_length=14, regex=^[0-9]{14}$
      - name: addressing_suffix
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          description: Addressing Suffix, min_length=1
          title: Addressing Suffix
        description: Addressing Suffix, min_length=1
      - name: addressing_identifier
        in: query
        required: false
        schema:
          type: string
          minLength: 9
          description: Addressing Identifier, min_length=9
          title: Addressing Identifier
        description: Addressing Identifier, min_length=9
      - name: routing_identifier
        in: query
        required: false
        schema:
          type: string
          minLength: 5
          description: Routing Identifier, min_length=5
          title: Routing Identifier
        description: Routing Identifier, min_length=5
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DirectoryEntry'
                title: Response 200 Search Directory Fr Get
        '504':
          description: Timeout
          content:
            application/json:
              example:
                error: timeout
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unknown error
          content:
            application/json:
              example:
                error: unknown
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service unreachable
          content:
            application/json:
              example:
                error: unreachable
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                Message: User is not authorized to access this resource with an explicit deny in an identity-based policy
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    History:
      properties:
        definitionDate:
          anyOf:
          - type: string
          - type: 'null'
          title: Definitiondate
        dateFrom:
          anyOf:
          - type: string
          - type: 'null'
          title: Datefrom
        createdBy:
          anyOf:
          - type: string
          - type: 'null'
          title: Createdby
        idInstance:
          anyOf:
          - type: string
          - type: 'null'
          title: Idinstance
      type: object
      title: History
    RoutingCode:
      properties:
        routingIdentifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Routingidentifier
        routingIdentifierType:
          anyOf:
          - type: string
          - type: 'null'
          title: Routingidentifiertype
        routingCodeName:
          anyOf:
          - type: string
          - type: 'null'
          title: Routingcodename
        managesLegalCommitment:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Manageslegalcommitment
        administrativeStatus:
          anyOf:
          - type: string
          - type: 'null'
          title: Administrativestatus
        address:
          anyOf:
          - $ref: '#/components/schemas/Address'
          - type: 'null'
      type: object
      title: RoutingCode
    LegalUnit:
      properties:
        siren:
          anyOf:
          - type: string
          - type: 'null'
          title: Siren
        businessName:
          anyOf:
          - type: string
          - type: 'null'
          title: Businessname
        entityType:
          anyOf:
          - type: string
          - type: 'null'
          title: Entitytype
        administrativeStatus:
          anyOf:
          - type: string
          - type: 'null'
          title: Administrativestatus
        diffusible:
          anyOf:
          - type: string
          - type: 'null'
          title: Diffusible
      type: object
      title: LegalUnit
    Address:
      properties:
        addressLine1:
          anyOf:
          - type: string
          - type: 'null'
          title: Addressline1
        addressLine2:
          anyOf:
          - type: string
          - type: 'null'
          title: Addressline2
        addressLine3:
          anyOf:
          - type: string
          - type: 'null'
          title: Addressline3
        postalCode:
          anyOf:
          - type: string
          - type: 'null'
          title: Postalcode
        countrySubdivision:
          anyOf:
          - type: string
          - type: 'null'
          title: Countrysubdivision
        locality:
          anyOf:
          - type: string
          - type: 'null'
          title: Locality
        countryCode:
          anyOf:
          - type: string
          - type: 'null'
          title: Countrycode
        countryName:
          anyOf:
          - type: string
          - type: 'null'
          title: Countryname
      type: object
      title: Address
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DirectoryEntry:
      properties:
        routingIdentifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Routingidentifier
        addressingIdentifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Addressingidentifier
        siren:
          anyOf:
          - type: string
          - type: 'null'
          title: Siren
        siret:
          anyOf:
          - type: string
          - type: 'null'
          title: Siret
        addressingSuffix:
          anyOf:
          - type: string
          - type: 'null'
          title: Addressingsuffix
        dateTo:
          anyOf:
          - type: string
          - type: 'null'
          title: Dateto
        effectiveEndDate:
          anyOf:
          - type: string
          - type: 'null'
          title: Effectiveenddate
        history:
          anyOf:
          - $ref: '#/components/schemas/History'
          - type: 'null'
        routingCode:
          anyOf:
          - $ref: '#/components/schemas/RoutingCode'
          - type: 'null'
        legalUnit:
          anyOf:
          - $ref: '#/components/schemas/LegalUnit'
          - type: 'null'
        facility:
          anyOf:
          - $ref: '#/components/schemas/Facility'
          - type: 'null'
      type: object
      title: DirectoryEntry
    Facility:
      properties:
        siret:
          anyOf:
          - type: string
          - type: 'null'
          title: Siret
        siren:
          anyOf:
          - type: string
          - type: 'null'
          title: Siren
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        facilityType:
          anyOf:
          - type: string
          - type: 'null'
          title: Facilitytype
        diffusible:
          anyOf:
          - type: string
          - type: 'null'
          title: Diffusible
        administrativeStatus:
          anyOf:
          - type: string
          - type: 'null'
          title: Administrativestatus
        address:
          anyOf:
          - $ref: '#/components/schemas/Address'
          - type: 'null'
      type: object
      title: Facility
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
      type: object
      required:
      - error
      title: ErrorResponse
      example:
        error: timeout
  securitySchemes:
    HTTPBasic:
      type: http
      scheme: basic