Spotnana Invoicing API

openapi: 3.1.0
info:
  title: Air Invoicing API
  version: v2
  description: APIs to perform search, checkout and book an air pnr
servers:
- url: https://api-ext-sboxmeta.partners.spotnana.com
  description: Sandbox URL
security:
- Bearer: []
tags:
- name: Invoicing
  description: APIs to manage invoicing.
paths:
  /v2/invoicing/invoice-data:
    post:
      tags:
      - Invoicing
      summary: Get Invoice Data
      description: This endpoint gets the invoice data for given invoice numbers
      operationId: getInvoiceData
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceDataRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceDataResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The specified resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    PaymentSourceMetadata:
      type: object
      title: PaymentSourceMetadata
      description: Metadata corresponding to the payment source.
      oneOf:
      - $ref: '#/components/schemas/CardMetadataWrapper'
      - $ref: '#/components/schemas/VirtualCardMetadataWrapper'
      - $ref: '#/components/schemas/RewardsProgramMetadataWrapper'
      - $ref: '#/components/schemas/CustomPaymentMethodMetadataWrapper'
      - $ref: '#/components/schemas/VendorProgramPaymentDescriptorWrapper'
    Money:
      type: object
      title: Money
      description: 'Money object containing details such as the amount, the currency code, and the converted amount.

        '
      required:
      - amount
      - currencyCode
      properties:
        amount:
          type: number
          format: double
          description: The numeric value for the amount of money.
          example: 510
        currencyCode:
          type: string
          description: The 3-letter currency code for the money amount (defined using ISO 4217 standard).
          example: GBP
        convertedAmount:
          type: number
          format: double
          description: 'The converted currency and amount that has been converted (if a currency conversion has been requested).

            For example, if the call requests that money be sent in a specified currency (because the frontend requested

            the backend to send money in the user''s preferred currency).

            '
          example: 715.42
        convertedCurrency:
          type: string
          description: The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
          example: USD
        otherCoinage:
          type: array
          title: OtherCoinage
          description: List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.
          items:
            type: object
            properties:
              coinageCode:
                $ref: '#/components/schemas/PaymentMethod'
                description: Payment method
              amount:
                type: number
                format: double
                example: 1000
              conversionRate:
                type: number
                format: double
                description: 1 coin in this system equals to how many currency value
                example: 0.01
              preferredCurrencyConversionRate:
                type: number
                format: double
                description: 1 coin in this system equals to how many currency value
                example: 0.01
              otherCoinageMetadata:
                description: Metadata to store additional information related to the payment method
                discriminator:
                  propertyName: metadataType
                  mapping:
                    FlightPassPaymentMetadata: '#/components/schemas/FlightPassPaymentMetadataWrapper'
                oneOf:
                - $ref: '#/components/schemas/FlightPassPaymentMetadataWrapper'
    ProgramDetails:
      type: object
      title: ProgramDetails
      description: Descriptor for programs details.
      required:
      - uscId
      - tourCode
      - snapCode
      properties:
        uscId:
          type: string
          description: Contract Id between vendor and the client.
        tourCode:
          type: string
          description: Tracking code to know which company has booked the ticket, it is added to the price quote and ticket.
        snapCode:
          type: string
          description: Discount code.
    DirectBillingWrapper:
      type: object
      title: DirectBillingWrapper
      description: Wrapper for DirectBilling
      properties:
        directBilling:
          $ref: '#/components/schemas/DirectBilling'
    Invoice:
      type: object
      title: Invoice
      description: Invoice Data for single invoice
      required:
      - invoiceNumber
      - invoiceId
      - data
      properties:
        invoiceNumber:
          description: The invoice number
          type: string
          example: SPOT-0001232
        invoiceId:
          description: The invoice ID
          type: string
          example: d694cf94-534e-410e-b66b-11ef970622bc
        data:
          description: The invoice content
          $ref: '#/components/schemas/InvoiceData'
    FlightPassTax:
      type: object
      title: FlightPassTax
      description: A single tax component of the flight pass fare.
      properties:
        code:
          type: string
          description: Tax code identifier (e.g. GST_HST, QST, OTHER).
          example: GST_HST
        amount:
          description: Tax amount.
          $ref: '#/components/schemas/Money'
    ProductType:
      description: Type of product being invoiced
      type: string
      enum:
      - PNR
      - SERVICE_FEE
      example: PNR
    VendorProgramPaymentDescriptorWrapper:
      type: object
      title: VendorProgramPaymentDescriptorWrapper
      description: Wrapper for VendorProgramPaymentDescriptor
      properties:
        vendorProgramPaymentDescriptor:
          $ref: '#/components/schemas/VendorProgramPaymentDescriptor'
    HotelItemNameMetadata:
      title: HotelItemNameMetadata
      type: object
      description: HotelItemNameMetadata information.
      required:
      - pnrType
      properties:
        pnrType:
          type: string
          example: HOTEL
        hotelName:
          description: Name of the hotel.
          type: string
          example: Hilton
        hotelCity:
          description: City of the hotel.
          type: string
          example: New York
        checkInDate:
          description: Check in date.
          $ref: '#/components/schemas/DateModel'
        nights:
          description: Number of nights.
          type: string
          example: 2 Nights
    TokenizedExpiryWrapper:
      type: object
      title: TokenizedExpiryWrapper
      properties:
        tokenizedExpiry:
          $ref: '#/components/schemas/TokenizedExpiry'
    RailNameInvoiceMetadata:
      title: RailNameInvoiceMetadata
      type: object
      description: RailMetadata information.
      properties:
        vendor:
          description: Name of the rail.
          type: string
          example: Amtrak
        trainTableId:
          description: Train number.
          type: string
          example: A123
        origin:
          description: Origin of the train.
          type: string
          example: Washington Union Station
        destination:
          description: Destination of the train.
          type: string
          example: South Station
        date:
          description: Date of the journey.
          $ref: '#/components/schemas/DateModel'
        travelClass:
          description: Travel class.
          $ref: '#/components/schemas/RailTravelClass'
          example: FIRST
        fareType:
          description: Fare type.
          type: string
          example: Flexible Fare
        confirmationNumber:
          description: Confirmation number.
          type: string
          example: '1234567890'
    CustomPaymentMethodMetadataWrapper:
      type: object
      title: CustomPaymentMethodMetadataWrapper
      description: Wrapper for CustomPaymentMethodMetadata
      properties:
        customPaymentMethodMetadata:
          $ref: '#/components/schemas/CustomPaymentMethodMetadata'
    BuyerInfo:
      type: object
      title: BuyerInfo
      description: Buyer of items mentioned in the invoice.
      required:
      - name
      - address
      properties:
        name:
          description: Name of buyer, usually a traveler.
          type: string
          example: John Doe
          x-pii: SENSITIVE
        address:
          description: Address of buyer. Could be office, legal entity or org address.
          type: string
          example: '115 Broadway Suite 04-101,

            New York, NY 10006'
          x-pii: SENSITIVE
        taxId:
          description: Tax number for the seller, for ex GSTN in India
          type: string
          example: TXG239023092
          deprecated: true
          x-sunset: '2026-07-01'
        idInfo:
          type: array
          description: The seller ID information.
          items:
            $ref: '#/components/schemas/IdInfo'
    RailTravelClass:
      description: Travel class
      type: string
      enum:
      - FIRST
      - STANDARD
      - BUSINESS
      - SLEEPER
      - STANDARD_PREMIUM
      - BUSINESS_PREMIUM
      - COACH
      - ROOM
      - EXECUTIVE
      example: FIRST
    TaxBreakdown:
      type: array
      items:
        $ref: '#/components/schemas/Tax'
    AirNameInvoiceMetadata:
      title: AirNameInvoiceMetadata
      type: object
      description: invoice metadata for Air Pnr.
      required:
      - airlineName
      - flightNumber
      - origin
      - destination
      - cabin
      properties:
        airlineName:
          description: Name of the airline.
          type: string
          example: United Airlines
        flightNumber:
          description: Flight number.
          type: string
          example: UA 123
        origin:
          description: Origin of the flight.
          type: string
          example: SFO
        destination:
          description: Destination of the flight.
          type: string
          example: EWR
        date:
          description: Date of the flight.
          $ref: '#/components/schemas/DateModel'
        cabin:
          description: Cabin class.
          $ref: '#/components/schemas/Cabin'
          example: ECONOMY
        ancillary:
          description: Ancillary services.
          type: string
          example: Seat Purchase
    VendorProgramPaymentDescriptor:
      type: object
      title: VendorProgramPaymentDescriptor
      description: Descriptor for vendor program payment.
      required:
      - vendorProgramPaymentMetadata
      properties:
        vendorInfo:
          $ref: '#/components/schemas/VendorInfo'
        vendorProgramPaymentMetadata:
          $ref: '#/components/schemas/VendorProgramPaymentMetadata'
    ErrorResponse:
      type: object
      properties:
        debugIdentifier:
          type: string
          description: Link to debug the error internally.
        errorMessages:
          type: array
          items:
            type: object
            properties:
              errorCode:
                type: string
                description: Error code to identify the specific errors.
              message:
                type: string
                description: Message containing details of error.
              errorParameters:
                type: array
                description: Error message parameters.
                items:
                  $ref: '#/components/schemas/ErrorParameter'
              errorDetail:
                type: string
                description: More details about the error.
    InvoiceData:
      type: object
      title: InvoiceData
      description: Actual Data
      required:
      - issuedDate
      - seller
      - buyer
      - items
      - payments
      - productId
      - productType
      - referenceIds
      - invoiceAmount
      properties:
        issuedDate:
          description: Date of invoice issue
          $ref: '#/components/schemas/DateModel'
        seller:
          description: Entity that sold the items mentioned in the invoice.
          $ref: '#/components/schemas/SellerInfo'
        buyer:
          description: Buyer of items mentioned in the invoice.
          $ref: '#/components/schemas/BuyerInfo'
        items:
          description: Items being invoiced.
          type: array
          items:
            $ref: '#/components/schemas/Item'
        payments:
          description: Information on how the items have been paid for.
          type: array
          items:
            $ref: '#/components/schemas/PaymentInformation'
        productId:
          description: ID of the product being invoiced
          type: string
          example: '123243223'
        productType:
          description: Type of product for which invoice is generated.
          $ref: '#/components/schemas/ProductType'
        invoiceAmount:
          description: Total invoice amount.
          $ref: '#/components/schemas/FareAmount'
        taxBreakdown:
          description: Tax breakdown for the invoice, this will be present for UK invoices with VAT
          $ref: '#/components/schemas/TaxBreakdown'
        referenceIds:
          description: Reference Numbers to be shown on the invoice, for ex, Trip ID, PNR ID etc.
          type: array
          items:
            $ref: '#/components/schemas/ReferenceId'
        regionCode:
          description: The region code for which the invoice is generated.
          $ref: '#/components/schemas/RegionCode'
          example: US
        documentType:
          description: Type of document
          type: string
          enum:
          - INVOICE
          - RECEIPT
          - NONE
          example: INVOICE
        footerText:
          description: Text shown at bottom of the PDF document. Nothing is shown if not set.
          type: string
          example: This document is proof of payment. If you require a tax invoice, please request one from the travel provider.
        supplierType:
          description: SupplierType for PNR, for eg. NDC, Sabre etc.
          $ref: '#/components/schemas/ThirdPartySource'
    ActualPayment:
      title: ActualPayment
      type: object
      description: Payment done via supported Spotnana payment types.
      required:
      - paymentSourceType
      - paymentMetadata
      properties:
        paymentSourceType:
          description: Type of payment source.
          $ref: '#/components/schemas/PaymentSourceType'
        paymentMetadata:
          description: Type of payment source.
          $ref: '#/components/schemas/PaymentSourceMetadata'
    Tax:
      type: object
      title: Tax
      description: Tax details
      required:
      - amount
      properties:
        amount:
          $ref: '#/components/schemas/Money'
          description: Tax amount
        taxCode:
          type: string
          description: Tax code
          example: VAT
        percentage:
          type: number
          format: double
          description: Tax amount to total amount
          example: 9
    PaymentSourceType:
      type: string
      description: Type of Payment Source
      enum:
      - CARD
      - VIRTUAL_CARD
      - REWARDS_PROGRAM
      - DELAYED_INVOICING
      - CUSTOM_PAYMENT_METHOD
      - VENDOR_PROGRAM_PAYMENT
      - UNUSED_CREDIT
      - CASH
    RewardsProgramMetadata:
      type: object
      title: RewardsProgramMetadata
      description: Metadata for Rewards Program payment source.
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/RewardsProgramType'
        pointsBalance:
          $ref: '#/components/schemas/PointsBalance'
    InvoiceDataRequest:
      type: object
      title: InvoiceDataRequest
      description: Invoice Data Request
      required:
      - invoices
      properties:
        tmcId:
          deprecated: true
          x-sunset: '2026-07-01'
          description: TMC for which invoice is being requested. Deprecated in favor of invoiceIds.
          type: string
          example: 15c94ac1-f540-4916-9243-306a75fbd8a9
        invoiceNumbers:
          deprecated: true
          x-sunset: '2026-07-01'
          description: One or more invoice numbers being requested. Deprecated in favor of invoiceIds.
          type: array
          items:
            type: string
        invoiceIds:
          description: One or more Invoice IDs being requested
          type: array
          items:
            type: string
            format: uuid
            example: 15c94ac1-f540-4916-9243-306a75fbd8a9
    CardCompany:
      type: string
      enum:
      - NONE
      - VISA
      - MASTERCARD
      - AMEX
      - DISCOVER
      - AIR_TRAVEL_UATP
      - CARTE_BLANCHE
      - DINERS_CLUB
      - JCB
      - BREX
      - UNION_PAY
      - EURO_CARD
      - ACCESS_CARD
      - ELO_CARD
      description: The issuing company of card
      example: VISA
    RegionCode:
      description: The region code for which the following invoicing information is applicable.
      type: string
      enum:
      - US
      - UK
      - NL
      - SG
      - CA
      - MX
      - DO
      - AR
      - BR
      - CO
      - GT
      - PE
      - CR
      - IL
      - NOR
      - AE
      - SE
      - TR
      - PL
      - SA
      - ZA
      - AU
      - CN
      - HK
      - IN
      - ID
      - JP
      - KR
      - MY
      - NZ
      - PH
      - TH
      - VN
      - FR
      - DK
      - CZ
      - HU
      - AL
      - BY
      - BA
      - BG
      - IS
      - AD
      - AT
      - BE
      - CY
      - EE
      - FI
      - DE
      - GR
      - IE
      - IT
      - XK
      - LV
      - LT
      - LU
      - MC
      - ME
      - MT
      - PT
      - SM
      - SK
      - SI
      - ES
      - VA
      - HR
      - LI
      - MD
      - MK
      - RO
      - RU
      - RS
      - CH
      - UA
      - GB
      - TW
      example: US
    SimpleMoney:
      type: object
      title: SimpleMoney
      description: Money object containing just amount and currency code.
      required:
      - amount
      - currencyCode
      properties:
        amount:
          type: number
          format: double
          description: Amount
          example: 510
        currencyCode:
          type: string
          description: The 3-letter currency code defined in ISO 4217.
          example: GBP
    Expiry:
      title: Expiry
      type: object
      description: Contains the expiry of a Card.
      required:
      - expiryMonth
      - expiryYear
      properties:
        expiryMonth:
          type: integer
          format: int32
          minimum: 1
          maximum: 12
          description: Expiry month
          example: 1
        expiryYear:
          type: integer
          format: int32
          description: Expiry year
          minimum: 2000
          example: 2010
    NoPrepaymentWrapper:
      type: object
      title: NoPrepaymentWrapper
      description: Wrapper for No Prepayment Payment Source.
      required:
      - noPrepaymentMetadata
      properties:
        noPrepaymentMetadata:
          $ref: '#/components/schemas/NoPrepaymentMetadata'
    SellerInfo:
      type: object
      title: SellerInfo
      description: Entity that sold the items mentioned in the invoice.
      required:
      - name
      - address
      properties:
        name:
          description: Name of seller, usually a TMC Legal Entity.
          type: string
          example: Spotnana India Pvt. Ltd.
        address:
          description: Address of seller.
          type: string
          example: '115 Broadway Suite 04-101,

            New York, NY 10006'
        taxId:
          description: Tax number for the seller, for ex GSTN in India
          type: string
          example: TXG239023092
          deprecated: true
          x-sunset: '2026-07-01'
        idInfo:
          type: array
          description: The seller ID information.
          items:
            $ref: '#/components/schemas/IdInfo'
    DirectBilling:
      type: object
      title: DirectBilling
      description: Descriptor for direct billing details.
      properties:
        directBillingCode:
          type: string
          description: Direct billing code provided by the vendor.
        corporateDiscountCode:
          type: string
          deprecated: true
          x-sunset: '2026-07-01'
          description: Corporate discount code provided by the vendor.
        label:
          type: string
          description: Label for the Direct Billing Payment method.
    DateTimeRange:
      type: object
      properties:
        min:
          $ref: '#/components/schemas/DateTimeLocal'
          description: Minimum value - inclusive.
        max:
          $ref: '#/components/schemas/DateTimeLocal'
          description: Maximum value - inclusive.
    AirlineProgram:
      type: object
      title: AirlineProgram
      description: Descriptor for Airline program details.
      required:
      - airlineInfo
      - airlineProgramMetadata
      properties:
        airlineInfo:
          type: array
          description: Eligible airlines' information list.
          items:
            $ref: '#/components/schemas/Airline'
        airlineProgramMetadata:
          description: Airline program payment specific metadata.
          $ref: '#/components/schemas/AirlineProgramMetadata'
    FlightPassPaymentMetadata:
      type: object
      title: FlightPassPaymentMetadata
      description: Metadata specific to Flight Pass payment method in OtherCoinage.
      properties:
        flightPassNumber:
          type: string
          description: Flight pass number
          example: FP123456789
        flightPassAmounts:
          $ref: '#/components/schemas/FlightPassPaymentAmounts'
    CardMetadata:
      type: object
      title: CardMetadata
      description: Metadata for Card payment source.
      required:
      - card
      properties:
        card:
          $ref: '#/components/schemas/Card'
    VirtualPaymentMetadata:
      type: object
      title: VirtualPaymentMetadata
      required:
      - label
      description: Metadata for custom virtual payment source.
      properties:
        label:
          type: string
          example: Custom payment card
          description: Label for custom virtual payment source.
    FareAmount:
      type: object
      title: FareAmount
      description: Fare amount including base fare and tax.
      required:
      - base
      - tax
      properties:
        base:
          description: Base fare amount.
          $ref: '#/components/schemas/Money'
        tax:
          description: Tax amount.
          $ref: '#/components/schemas/Money'
        taxBreakdown:
          description: Breakdown of tax amounts.
          $ref: '#/components/schemas/TaxBreakdown'
    Item:
      type: object
      title: Item
      description: Item being invoiced.
      required:
      - name
      - identifier
      - type
      - amount
      - travelerName
      - purchaseType
      properties:
        name:
          description: Name of the item.
          type: string
          example: Air Ticket SFO-EWR
        identifier:
          description: Number identifying the item, for ex, the ticket number for air ticket.
          type: string
          example: 00129383829
        purchaseType:
          description: Type of item, indicates what type of item is being sold
          type: string
          enum:
          - TRIP_FEE
          - FLIGHT
          - ANCILLARY
          - HOTEL
          - CAR
          - RAIL
          - MERCHANT_FEE
          - LIMO
          - MISC
          example: TRIP_FEE
        type:
          description: Type of item, indicates if the item was purchased vs refunded.
          type: string
          enum:
          - PURCHASE
          - REFUND
          example: PURCHASE
        amount:
          description: Amount of money.
          $ref: '#/components/schemas/FareAmount'
        travelerName:
          description: Name of the traveler.
          type: string
          example: John Doe
        taxBreakdown:
          description: Tax breakdown for the invoice, this will be present for UK invoices with VAT
          $ref: '#/components/schemas/TaxBreakdown'
        itemNameMetadata:
          description: Metadata for the item name.
          $ref: '#/components/schemas/ItemNameMetadata'
    FlightPassMetadata:
      type: object
      title: FlightPassMetadata
      required:
      - label
      description: Metadata for FlightPass payment source.
      properties:
        label:
          type: string
          example: Air Canada Flight Pass
          description: Label for FlightPass payment source.
    TokenizedExpiry:
      title: TokenizedExpiry
      type: object
      description: Contains the tokenized expiry of a Card.
      required:
      - expiryMonth
      - expiryYear
      properties:
        expiryMonth:
          type: string
          description: Tokenized Expiry month
          example: KvAuPANQWCpjwRQxcC8EXg==
        expiryYear:
          type: string
          description: Tokenized Expiry year
          example: fPBm0OWrKwPyIrCVcbg4cA==
    VirtualCardMetadata:
      type: object
      title: VirtualCardMetadata
      description: Metadata for Virtual Card payment source.
      required:
      - vendor
      - cardLabel
      - company
      properties:
        vendor:
          $ref: '#/components/schemas/VirtualCardVendor'
        cardLabel:
          type: string
          description: Name/Label for visual identification of the card.
          example: cardCompany
        company:
          $ref: '#/components/schemas/CardCompany'
        paymentInstruction:
          $ref: '#/components/schemas/PaymentInstruction'
    TicketStatus:
      description: Status of the ticket.
      type: string
      enum:
      - UNKNOWN
      - ISSUED
      - VOIDED
      - REFUNDED_EXCHANGED
      - EXCHANGED
      example: ISSUED
    QantasTravelFundMetadataWrapper:
      type: object
      title: QantasTravelFundMetadataWrapper
      description: Wrapper for QantasTravelFundMetadata
      required:
      - qantasTravelFundMetadata
      properties:
        qantasTravelFundMetadata:
          $ref: '#/components/schemas/QantasTravelFundMetadata'
    VendorInfo:
      type: object
      title: VendorInfo
      description: Name/ID etc. of the vendor.
      required:
      - vendorId
      - vendorName
      properties:
        vendorId:
          type: string
          description: ID of the vendor.
        vendorName:
          type: string
          description: Name of the vendor.
    PaymentInformation:
      type: object
      title: PaymentInformation
      description: Information on how the items have been paid for.
      required:
      - amount
      - paymentMode
      - paymentInstrumentIdentifier
      properties:
        id:
          description: Payment reference ID.
          type: string
          example: sdkljhafisudlls
        transactionTime:
          description: Transaction timestamp.
          $ref: '#/components/schemas/DateTimeOffset'
        amount:
          description: Amount paid.
          $ref: '#/components/schemas/Money'
        paymentMode:
          description: Mode of Payment shown on invoice.
          type: string
          enum:
          - CREDIT_CARD
          - ON_ACCOUNT
          - DIRECT
          - EXCHANGE
          - BREX_POINTS
          - CASH
          - QANTAS_POINTS
          - VENDOR_PROGRAM_PAYMENT
          - AMADEUS_CHECKOUT
          - PREVIOUS_BOOKING_VALUE
          - FLIGHT_CREDITS
          - QANTAS_TRAVEL_FUND
          - FLIGHT_PASS
          - MISCELLANEOUS_CREDIT_ORDER
          - NO_PREPAYMENT
          x-ignoreBreakingChanges:
          - PaymentInformation->paymentMode
          example: CREDIT_CARD
        paymentInstrumentIdentifier:
          description: An identifier for the payment instrument used. For example, last four credit card number digits in case a credit card was used.
          type: string
          example: '**2343'
        actualPayment:
          description: Details of how payment was done
          $ref: '#/components/schemas/ActualPayment'
        exchangePayment:
          description: Details of how payment was done
          $ref: '#/components/schemas/ExchangePayment'
    PostalAddress:
      title: PostalAddress
      description: Postal Address Details
      type: object
      required:
      - addressLines
      - regionCode
      properties:
        addressLines:
          description: Address lines
          type: array
          items:
            type: string
            example: Golden Gate Bridge
        administrativeArea:
          type: string
          description: 'Code of administrative area. For example: DL for Delhi, India.

            Highest administrative subdivision which is used for postal

            addresses of a country or region.

            For example, this can be a state, a province, an oblast, or a prefecture.

            Specifically, for Spain this is the province and not the autonomous

            community (e.g. "Barcelona" and not "Catalonia").

            Many countries don''t use an administrative area in postal addresses. E.g.

            in Switzerland this should be left unpopulated.

            '
          example: CA
        administrativeAreaName:
          type: string
          description: "Name of administrative area. This is full name corresponding to administrativeArea. \nLike Delhi for DL area code. For some places, code and name maybe same as well like Tokyo.\n"
          example: California
        description:
          description: Address description
          type: string
          example: San Francisco Home
        isDefault:
          description: Whether this address is default address in case multiple addresses are specified.
          type: boolean
          example: true
        languageCode:
          description: "BCP-47 language code of the contents of this address (if known). This is often the UI \nlanguage of the input form or is expected to match one of the languages used in the \naddress' country/region, or their transliterated equivalents.\nThis can affect formatting in certain countries, but is not critical to the correctness \nof the data and will never affect any validation or other non-formatting related operations.\nExamples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".\n"
          type: string
          example: en
        locality:
          description: Generally refers to the city/town portion of the address.
          type: string
          example: San Francisco
        locationCode:
          description: IATA 3-letter location code. See https://www.iata.org/en/services/codes.
          type: string
          example: LAX
        organization:
          description: The name of the organization at the address.
          type: string
          example: Spotnana
        postalCode:
          description: Postal code of the address. This is a required field when setting for a user/legal entity/company etc.
          type: string
          example: '94130'
        continentCode:
          description: 2 letter continent code of the continent this address falls in.
          type: string
          example: AF
        recipients:
          description: The recipient at the address.
          type: array
          items:
            type: string
        regionCode:
          description: Region code of the country/region of the address.
          type: string
          example: US
        regionNam

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spotnana/refs/heads/main/openapi/spotnana-invoicing-api-openapi.yml