Orderful Inbox API

openapi: 3.2.0
info:
  title: Orderful Conversion Inbox API
  description: The official Orderful API documentation.
  version: 2.15.0
  contact:
    name: Orderful
    url: https://orderful.com
    email: developers@orderful.com
  termsOfService: https://orderful.com/terms-and-conditions/
servers:
- url: https://api.orderful.com
tags:
- name: Inbox
  description: Retrieve transactions from inboxes.
paths:
  /inboxes/{inboxId}/transactions:
    get:
      operationId: InboxController_list
      summary: Inbox
      description: 'Retrieves the Transactions from the specified Inbox.


        **Note:** The `inboxId` can be found by logging in to [ui.orderful.com](https://ui.orderful.com) and navigating to "Communication Channels".

        '
      tags:
      - Inbox
      parameters:
      - name: inboxId
        required: true
        in: path
        schema:
          type: number
      - name: limit
        required: false
        in: query
        description: Value can be `1-100`. Default value is `30`. **Note:** Response size is limited to 200MB. We will return the maximum number of transactions possible without exceeding either the specified `limit` or the maximum response size.
        schema:
          type: number
      - name: orderful-api-version
        in: header
        description: Specifies the API version to use.
        schema:
          type: string
          default: v4
      responses:
        '200':
          description: Transactions retrieved successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InboxTransactionsResponseDto'
              examples:
                purchaseOrders:
                  summary: Purchase Orders in Inbox
                  value:
                  - integrationPayloadId: 019be412-5a85-714c-8ba6-436c1c06efd8
                    transactionId: 802210971
                    senderId: MosaicNT
                    receiverId: MosaicDemo
                    stream: test
                    message:
                      purpose: original
                      purchaseOrderType: standalone
                      purchaseOrderNumber: PO-2024-001234
                      purchaseOrderDate: '2024-02-01'
                      parties:
                        billTo:
                          name: Acme Corporation
                          addressLine1: 123 Main Street
                          addressLine2: Accounts Payable
                          city: Chicago
                          stateOrProvinceCode: IL
                          postalCode: '60601'
                          countryCode: US
                          contacts:
                          - type: primary
                            name: Accounts Payable
                            phoneNumber: 312-555-0400
                            email: ap@acme.com
                        shipTo:
                          name: Acme Corporation - Warehouse
                          identificationCode: '987654321'
                          addressLine1: 456 Warehouse Boulevard
                          city: Elk Grove Village
                          stateOrProvinceCode: IL
                          postalCode: '60007'
                          countryCode: US
                          contacts:
                          - type: primary
                            name: Receiving Department
                            phoneNumber: 847-555-0300
                        buyer:
                          contacts:
                          - type: primary
                            name: John Smith
                            phoneNumber: 312-555-0100
                            email: john.smith@acme.com
                      termsOfSale:
                        discountDaysDue: 10
                        netDaysDue: 30
                      notes:
                        general:
                          text:
                          - Please ensure all items are properly packaged
                          - Contact receiving department 24 hours before delivery
                      references:
                        vendorNumber:
                          value: VND-456
                      dates:
                        requestedDeliveryDate: '2024-02-15'
                        requestedShipDate: '2024-02-10'
                      carrierDetails:
                        routing:
                        - description: FedEx Ground service
                        freeOnBoard:
                        - methodOfPayment: prepaidBySeller
                          locationType: destination
                          locationDescription: Dallas, TX
                      monetaryAmounts:
                        net: '10000'
                      lineItems:
                      - purchaseOrderLineId: '1'
                        quantity:
                          value: '100'
                          unitOfMeasure: each
                        unitCostPrice: '45.00'
                        productIds:
                          vendorItemNumber: GSI-78901
                          buyerItemNumber: ACME-12345
                          gtin13: '1234567890123'
                        dates:
                          requestedShipDate: '2024-02-10'
                      - purchaseOrderLineId: '2'
                        quantity:
                          value: '250'
                          unitOfMeasure: case
                        unitCostPrice: '18.50'
                        productIds:
                          vendorItemNumber: GSI-23456
                          buyerItemNumber: ACME-67890
                          gtin14: '12345678901234'
                        outerPack:
                          numberOfUnits: '25'
                        dates:
                          requestedShipDate: '2024-02-10'
                      - purchaseOrderLineId: '3'
                        quantity:
                          value: '50'
                          unitOfMeasure: each
                        unitCostPrice: '17.50'
                        productIds:
                          vendorItemNumber: GSI-33333
                          buyerItemNumber: ACME-11111
                          gtin12: '123456789012'
                        dates:
                          requestedShipDate: '2024-02-10'
                    delivery:
                      deliveryId: b646771e-a068-4e32-832f-e96f895c5ec9
                      transactionId: 802210971
                      href: https://api.orderful.com/transactions/802210971/deliveries/b646771e-a068-4e32-832f-e96f895c5ec9
                      approve:
                        href: https://api.orderful.com/transactions/802210971/deliveries/b646771e-a068-4e32-832f-e96f895c5ec9/accept
                      fail:
                        href: https://api.orderful.com/transactions/802210971/deliveries/b646771e-a068-4e32-832f-e96f895c5ec9/fail
components:
  schemas:
    TaxDetails:
      type: object
      description: Tax details (TXI or TAX segment).
      properties:
        amount:
          type: string
          description: Tax amount (TXI02).
        percent:
          type: string
          description: Tax percentage (TXI03).
        taxIdNumber:
          type: string
          description: Tax ID number (TXI09 or TAX01).
        locationId:
          type: string
          description: Location identifier (TAX03).
        exemptionCode:
          type: string
          enum:
          - exempt
          - notExempt
          - notTaxable
        jurisdictionType:
          type: string
          description: Tax jurisdiction type (TXI04).
        jurisdictionCode:
          type: string
          description: Tax jurisdiction code (TXI05).
        assignedId:
          type: string
          description: Assigned identification (TXI10).
    Paperwork:
      type: object
      properties:
        type:
          type: string
        description:
          type: string
        required:
          type: boolean
    InboxTransactionsResponseDto:
      type: object
      description: Transaction retrieved from an inbox.
      required:
      - integrationPayloadId
      - transactionId
      - senderId
      - receiverId
      - stream
      - message
      - delivery
      properties:
        integrationPayloadId:
          type: string
          format: uuid
          description: Unique identifier for this integration payload.
          example: 019be412-5a85-714c-8ba6-436c1c06efd8
        transactionId:
          type: integer
          description: Transaction ID.
          example: 802210971
        senderId:
          type: string
          description: Sender ISA ID.
          example: MosaicNT
        receiverId:
          type: string
          description: Receiver ISA ID.
          example: MosaicDemo
        stream:
          type: string
          description: Environment stream.
          enum:
          - test
          - live
          example: test
        message:
          description: Transaction document. Structure depends on the transaction type.
          oneOf:
          - $ref: '#/components/schemas/850_PURCHASE_ORDER'
          - $ref: '#/components/schemas/855_PURCHASE_ORDER_ACKNOWLEDGMENT'
          - $ref: '#/components/schemas/856_SHIP_NOTICE_MANIFEST'
          - $ref: '#/components/schemas/810_INVOICE'
          - $ref: '#/components/schemas/846_INVENTORY_ADVICE'
          - $ref: '#/components/schemas/860_PURCHASE_ORDER_CHANGE'
        delivery:
          $ref: '#/components/schemas/InboxDelivery'
    PricingInfo:
      type: object
      properties:
        priceType:
          type: string
          enum:
          - retail
          - wholesale
          - promotional
          - contract
        price:
          type: string
        quantity:
          type: string
    POChangeLineItem:
      type: object
      description: Purchase order change line item.
      properties:
        purchaseOrderLineId:
          type: string
          description: Line item identifier.
        changeReason:
          type: string
          description: REQUIRED. Reason for the change.
          enum:
          - changeToItem
          - addItem
          - deleteItem
          - priceChange
          - quantityChange
        originalQuantity:
          description: Original ordered quantity before change.
          allOf:
          - $ref: '#/components/schemas/Quantity'
        changeInQuantity:
          description: Quantity delta (increase or decrease).
          allOf:
          - $ref: '#/components/schemas/Quantity'
        quantity:
          description: New total quantity after change.
          allOf:
          - $ref: '#/components/schemas/Quantity'
        unitCostPrice:
          type: string
          description: Unit cost price.
        unitPriceBasis:
          type: string
        productIds:
          $ref: '#/components/schemas/ProductIds'
        productAttributes:
          $ref: '#/components/schemas/ProductAttributes'
        dates:
          $ref: '#/components/schemas/Dates'
        notes:
          $ref: '#/components/schemas/Notes'
    InvoiceTaxes:
      type: object
      description: Invoice tax details (TXI segments).
      properties:
        harmonizedSalesTax:
          description: Harmonized sales tax (TXI01='BE').
          allOf:
          - $ref: '#/components/schemas/TaxDetails'
        goodsAndServicesTax:
          description: Goods and services tax (TXI01='GS').
          allOf:
          - $ref: '#/components/schemas/TaxDetails'
        stateProvincialTax:
          description: State/provincial tax (TXI01='SP').
          allOf:
          - $ref: '#/components/schemas/TaxDetails'
        stateProvincialGoodsTax:
          description: State/provincial goods tax (TXI01='PG').
          allOf:
          - $ref: '#/components/schemas/TaxDetails'
        localTax:
          description: Local tax (TXI01='SL' or 'LS').
          allOf:
          - $ref: '#/components/schemas/TaxDetails'
    ProductIdDetail:
      type: object
      properties:
        type:
          type: string
          description: REQUIRED. Product ID type.
        value:
          type: string
          description: REQUIRED. Product ID value.
    References:
      type: object
      description: Reference numbers.
      properties:
        accountNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        arrivalCode:
          $ref: '#/components/schemas/ReferenceDetail'
        associatedPurchaseOrderNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        reservationNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        customerOrderNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        deliveryReference:
          $ref: '#/components/schemas/ReferenceDetail'
        divisionId:
          $ref: '#/components/schemas/ReferenceDetail'
        departmentNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        internalCustomerNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        vendorNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        merchandiseTypeCode:
          $ref: '#/components/schemas/ReferenceDetail'
        promotionNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        storeNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        thirdPartyReferenceNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        warehouseStorageLocation:
          $ref: '#/components/schemas/ReferenceDetail'
        shipmentNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        invoiceNumber:
          $ref: '#/components/schemas/ReferenceDetail'
    AsnCarton:
      type: object
      description: Carton in shipment.
      properties:
        trackingNumber:
          type: string
        serialShippingId:
          type: string
          description: SSCC-18 code.
        cartonPhysicalDetails:
          $ref: '#/components/schemas/PhysicalDetails'
        specialHandling:
          type: array
          items:
            $ref: '#/components/schemas/SpecialHandlingDetails'
        items:
          type: array
          items:
            $ref: '#/components/schemas/AsnItem'
    InvoiceParties:
      type: object
      description: Parties involved in invoice.
      properties:
        buyer:
          description: Buyer company (N1 segment, BY).
          allOf:
          - $ref: '#/components/schemas/Party'
        shipTo:
          description: Ship-to location (N1 segment, ST).
          allOf:
          - $ref: '#/components/schemas/Party'
        billTo:
          description: Bill-to location (N1 segment, BT).
          allOf:
          - $ref: '#/components/schemas/Party'
        accountsReceivable:
          description: Accounts receivable / Remit To / Payee (N1*RI or PER*AR).
          allOf:
          - $ref: '#/components/schemas/Party'
        accountsPayable:
          description: Accounts payable / Payer for credits (N1*15 or PER*AP).
          allOf:
          - $ref: '#/components/schemas/Party'
    Party:
      type: object
      description: Party details.
      properties:
        name:
          type: string
          description: Party name (N102).
        additionalName1:
          type: string
        additionalName2:
          type: string
        identificationCode:
          type: string
          description: ID code (N104).
        identificationCodeType:
          type: string
          enum:
          - sendersId
          - receiversId
          - duns
          - pantCode
          - dunsPlus4
          - drugEnforcementAdmin
          - telephone
          - federalReserveRouting
          - standardAddressSAN
          - healthIndustryHIN
          - warehouse
          - schoolId
          - memberId
          - stateLicenseId
          - globalLocationId
        addressLine1:
          type: string
        addressLine2:
          type: string
        addressLine3:
          type: string
        addressLine4:
          type: string
        city:
          type: string
        stateOrProvinceCode:
          type: string
        postalCode:
          type: string
        countryCode:
          type: string
        zoneType:
          type: string
          enum:
          - residential
          - commercial
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
    Notes:
      type: object
      description: Notes and instructions.
      properties:
        general:
          $ref: '#/components/schemas/NoteDetail'
        orderInstructions:
          $ref: '#/components/schemas/NoteDetail'
        shippingInstructions:
          $ref: '#/components/schemas/NoteDetail'
        giftMessage:
          $ref: '#/components/schemas/NoteDetail'
        packingSlipMessage:
          $ref: '#/components/schemas/NoteDetail'
    POAckLineItem:
      type: object
      description: Line item acknowledgment details.
      properties:
        purchaseOrderLineId:
          type: string
          description: Original PO line item ID.
        productIds:
          $ref: '#/components/schemas/ProductIds'
        productAttributes:
          $ref: '#/components/schemas/ProductAttributes'
        actions:
          type: array
          description: REQUIRED. Actions for this line item.
          items:
            $ref: '#/components/schemas/POAckAction'
    InboxDelivery:
      type: object
      description: Delivery information with action links.
      required:
      - deliveryId
      - transactionId
      - href
      - approve
      - fail
      properties:
        deliveryId:
          type: string
          format: uuid
          description: Delivery ID.
          example: b646771e-a068-4e32-832f-e96f895c5ec9
        transactionId:
          type: integer
          description: Transaction ID.
          example: 802210971
        href:
          type: string
          format: uri
          description: URL to retrieve delivery details.
          example: https://api.orderful.com/transactions/802210971/deliveries/b646771e-a068-4e32-832f-e96f895c5ec9
        approve:
          $ref: '#/components/schemas/HrefLink'
        fail:
          $ref: '#/components/schemas/HrefLink'
    HrefLink:
      type: object
      required:
      - href
      properties:
        href:
          type: string
    AsnItemReferences:
      type: object
      description: Item-level references for ASN shipments.
      properties:
        heatCode:
          $ref: '#/components/schemas/ReferenceDetail'
        billOfMaterial:
          $ref: '#/components/schemas/ReferenceDetail'
        barCode:
          $ref: '#/components/schemas/ReferenceDetail'
    Dates:
      type: object
      description: Order dates.
      properties:
        cancelAfterDate:
          type: string
          format: date
        customerOrderDate:
          type: string
          format: date
        earliestDeliveryDate:
          type: string
          format: date
        earliestShipDate:
          type: string
          format: date
        latestShipDate:
          type: string
          format: date
        latestDeliveryDate:
          type: string
          format: date
        pickupDate:
          type: string
          format: date
        promotionStartDate:
          type: string
          format: date
        purchaseOrderDate:
          type: string
          format: date
        requestedDeliveryDate:
          type: string
          format: date
        requestedShipDate:
          type: string
          format: date
        requestedDeliveryWeekOfDate:
          type: string
          format: date
    RoutingDetails:
      type: object
      properties:
        sequenceType:
          type: string
          enum:
          - origin
          - 1stAfterOrigin
          - 4thAfterOrigin
          - haulage
        standardCarrierAlphaCode:
          type: string
          description: SCAC code.
        customCarrierCode:
          type: string
        transportationMethod:
          type: string
          enum:
          - air
          - airExpress
          - airFreightForward
          - backhaul
          - bestWay
          - commonCarrier
          - consolidation
          - customerPickup
          - expeditedTruck
          - lessThanTrailerLoad
          - mail
          - ocean
          - oceanContainerized
          - parcelPost
          - privateCarrier
          - rail
          - shipperAgent
          - supplierTruck
          - mutuallyDefined
        locationType:
          type: string
          enum:
          - inStore
          - receiversLocation
          - allPoints
          - portOfArrival
          - portOfEmbarkation
          - origin
          - mutuallyDefined
        location:
          type: string
        description:
          type: string
        serviceLevel:
          type: string
          enum:
          - deliveryConfirmation
          - doorService
          - economy
          - eveningService
          - expedited
          - firstClass
          - ground
          - groundHundredWeight
          - international
          - metro
          - morning
          - nextDayAir
          - nextDayHundredWeight
          - nextDayEvening
          - nextDayMorning1030
          - nextDayMorning930
          - overnight
          - poBoxZipCode
          - priorityMail
          - priorityMailInsured
          - proofOfDelivery
          - sameDay
          - saturdayService
          - secondDay
          - secondDayHundredWeight
          - secondDayAir
          - standard
          - standardGround
          - threeDay
        orderStatus:
          type: string
          enum:
          - shipCompleteOnDate
          - complete
          - partialShipment
          - shipPartialBackorderToShipOnDate
          - partialShipOnDate
          - shipped
          - backordered
          - mutuallyDefined
          - availableScheduledToShip
          - availableNoShipSchedule
          - multiPickup
          - availableToShipUnBilledQuantity
          - stopOff
        transitDirectionType:
          type: string
          enum:
          - buyerToSeller
          - sellerToBuyer
          - subcontractorToSeller
          - sellerToDropShipLocation
          - sellToForwarder
          - sellerToSubcontractor
          - mutuallyDefined
        transitTimeType:
          type: string
          enum:
          - calendarDays
          - hours
          - workingDays
        transitTime:
          type: string
    ProductAttributes:
      type: object
      properties:
        description:
          type: string
        colorCode:
          type: string
        colorDescription:
          type: string
        sizeCode:
          type: string
        sizeDescription:
          type: string
        materialCode:
          type: string
        materialDescription:
          type: string
        processCode:
          type: string
        processDescription:
          type: string
        height:
          type: string
        width:
          type: string
    POLineItem:
      type: object
      description: Purchase order line item.
      properties:
        purchaseOrderLineId:
          type: string
        quantity:
          $ref: '#/components/schemas/Quantity'
        unitCostPrice:
          type: string
        unitPriceBasis:
          type: string
        additionalPricing:
          type: array
          items:
            $ref: '#/components/schemas/PricingInfo'
        productIds:
          description: REQUIRED. Product identifiers.
          allOf:
          - $ref: '#/components/schemas/ProductIds'
        productAttributes:
          $ref: '#/components/schemas/ProductAttributes'
        outerPack:
          $ref: '#/components/schemas/PhysicalDetails'
        innerPack:
          $ref: '#/components/schemas/PhysicalDetails'
        packaging:
          type: array
          items:
            $ref: '#/components/schemas/PackagingDetails'
        dates:
          $ref: '#/components/schemas/Dates'
        references:
          $ref: '#/components/schemas/References'
        destinationQuantities:
          type: array
          items:
            $ref: '#/components/schemas/DestinationQuantity'
        allowances:
          type: array
          items:
            $ref: '#/components/schemas/AllowanceCharge'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/AllowanceCharge'
        monetaryAmounts:
          $ref: '#/components/schemas/MonetaryAmounts'
        sublineItems:
          type: array
          items:
            $ref: '#/components/schemas/SublineItem'
        notes:
          $ref: '#/components/schemas/Notes'
        paperwork:
          type: array
          items:
            $ref: '#/components/schemas/Paperwork'
        conditionsAndRestrictions:
          type: array
          items:
            $ref: '#/components/schemas/Conditions'
        carrierDetails:
          $ref: '#/components/schemas/CarrierDetails'
    TermsOfSale:
      type: object
      description: Payment terms.
      properties:
        type:
          type: string
          enum:
          - basic
          - basicDiscountOffered
          - discountNotApplicable
          - endOfMonth
          - endOfMonth10
          - instant
          - mutuallyDefined
        basisDate:
          type: string
          enum:
          - invoiceDate
          - receiptOfGoods
          - deliveryDate
          - shipDate
          - mutuallyDefined
          - gageApprovalDate
          - specifiedDate
          - acceptanceDate
          - invoiceTransmissionDate
          - effectiveDate
        discountPercent:
          type: string
        discountDaysDue:
          type: integer
          description: Number of days in the discount period.
        discountDueDate:
          type: string
          format: date
        dayOfMonth:
          type: integer
        netDaysDue:
          type: integer
          description: Number of days until total invoice amount is due.
        netDueDate:
          type: string
          format: date
        discountAmount:
          type: string
          description: Total discount amount.
        description:
          type: string
        paymentMethodType:
          type: string
          enum:
          - check
          - letterOfCredit
          - wireTransfer
          - corporateTradePayment
          - specialAccount
          - directPayOthers
    Quantity:
      type: object
      properties:
        value:
          type: string
          description: REQUIRED. Quantity value.
        unitOfMeasure:
          type: string
          enum:
          - ball
          - assortment
          - ocularInsertSystem
          - bundle
          - bag
          - bottle
          - belt
          - box
          - cell
          - case
          - card
          - container
          - can
          - cartridge
          - cassette
          - carton
          - coil
          - combo
          - drum
          - display
          - dozen
          - each
          - knots
          - order
          - flakeTon
          - foot
          - gallon
          - gram
          - person
          - kit
          - pound
          - linearFoot
          - monetaryValue
          - milliliter
          - meter
          - ounce
          - threePack
          - sixPack
          - pail
          - pairInches
          - piece
          - pad
          - palletLift
          - packPAK
          - package
          - palletUnitLoad
          - pair
          - pint
          - quart
          - reel
          - roll
          - section
          - squareFoot
          - sheet
          - set
          - syringe
          - tube
          - tote
          - thousand
          - unit
          - vial
    NoteDetail:
      type: object
      properties:
        description:
          type: string
        text:
          type: array
          items:
            type: string
          description: Note text lines.
    ReferenceDetail:
      type: object
      properties:
        value:
          type: string
          description: REQUIRED. Reference value.
        description:
          type: string
    Conditions:
      type: object
      properties:
        type:
          type: string
        description:
          type: string
    850_PURCHASE_ORDER:
      type: object
      description: Purchase Order document - Buyer sends order to supplier.
      properties:
        purpose:
          type: string
          description: REQUIRED. Transaction purpose (BEG01).
          enum:
          - original
          - cancellation
          - change
          - replace
          - confirmation
        purchaseOrderType:
          type: string
          description: REQUIRED. PO type (BEG02).
          enum:
          - blanketEstimated
          - blanketFirm
          - dropship
          - release
          - rushOrder
          - standalone
        purchaseOrderNumber:
          type: string
          description: REQUIRED. Unique PO number (BEG03).
        purchaseOrderDate:
          type: string
          format: date
          description: REQUIRED. PO issue date (BEG05).
        contractNumber:
          type: string
          description: Contract number (BEG06).
        releaseNumber:
          type: string
          description: Release number for blanket orders (BEG04).
        acknowledgmentType:
          type: string
          description: Acknowledgment request type.
        parties:
          $ref: '#/components/schemas/Parties'
        dates:
          $ref: '#/components/schemas/Dates'
        references:
          $ref: '#/components/schemas/References'
        termsOfSale:
          $ref: '#/components/schemas/TermsOfSale'
        carrierDetails:
          $ref: '#/components/schemas/CarrierDetails'
        notes:
          $ref: '#/components/schemas/Notes'
        monetaryAmounts:
          $ref: '#/components/schemas/HeaderMonetaryAmounts'
        conditionsAndRestrictions:
          type: array
          items:
            $ref: '#/components/schemas/Conditions'
        lineItems:
          type: array
          description: REQUIRED. Order line items (PO1 loop).
          minItems: 1
          items:
            $ref: '#/components/schemas/POLineItem'
    DestinationQuantity:
      type: object
      properties:
        identificationCode:
          type: string
        identificationCodeType:
          type: string
        quantity:
          type: string
    AsnReferences:
      type: object
      properties:
        appointmentNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        billOfLadingNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        loadPlanningNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        pickupReferenceNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        proNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        trackingNumber:
          $ref: '#/components/schemas/ReferenceDetail'
        vendorNumber:
          $ref: '#/components/schemas/ReferenceDetail'
    810_INVOICE:
      type: object
      description: Invoice document - Supplier bills for shipped goods.
      properties:
        invoiceNumber:
          type: string
          description: REQUIRED. Unique invoice number (BIG02).
        invoiceDate:
          type: string
          format: date
          description: REQUIRED. Invoice date (BIG01).
        invoiceType:
          type: string
          description: Invoice type.
          enum:
          - invoice
          - creditMemo
          - debitMemo
          default: invoice
        purchaseOrderNumber:
          type: string
          description: Related PO number (BIG04).
        purchaseOrderDate:
          type: string
          format: date
          description: PO date (BIG03).
        shipmentIdentification:
          type: string
          description: Related shipment ID.
        originalInvoiceNumber:
          type: string
          description: Original invoice (for credit/debit memos).
        parties:
          $ref: '#/components/schemas/InvoiceParties'
        termsOfSale:
          $ref: '#/components/schemas/TermsOfSale'
        dates:
          $ref: '#/components/schemas/InvoiceDates'
        references:
          $ref: '#/components/schemas/References'
   

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