Loop receivable-invoices API

openapi: 3.2.0
info:
  title: Loop Onboarding artifacts Receivable Invoices API
  description: HTTP REST API for Loop Payments Onboarding.
  version: '1.0'
  contact: {}
servers:
- url: https://onboarding.api.loop.com
security:
- bearerAuth: []
tags:
- name: receivable-invoices
paths:
  /v1/receivable-invoices:
    get:
      description: Returns a list of receivable invoices.
      operationId: ReceivableInvoices_list
      parameters:
      - name: expand
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - lineItems.invoiceDeliveryMethod
            - shipments
            - shipments.exceptions
            - shipments.shipmentJobs
            - shipments.shipmentJobs.addresses
            - shipments.shipmentJobs.artifacts
            - shipments.shipmentJobs.jobTypeInfo.address
            - shipments.shipmentJobs.jobTypeInfo.organizations
            - shipments.shipmentJobs.jobTypeInfo.organizations.tags
            - shipments.shipmentJobs.organizations
            - shipments.shipmentJobs.organizations.tags
            - shipments.shipmentJobs.tags
            - supportingArtifacts
      - name: status
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - DRAFT
            - OPEN
            - VOID
            - PAID
      - name: revisedAfter
        required: false
        in: query
        description: Filter to only results that have been revised after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.
        schema:
          format: utc-timestamp
          example: '2020-01-01T00:00:00.000Z'
          type: string
      - name: revisedBefore
        required: false
        in: query
        description: Filter to only results that have been revised before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.
        schema:
          format: utc-timestamp
          example: '2020-01-01T00:00:00.000Z'
          type: string
      - name: first
        required: false
        in: query
        description: The number of results to return. Default value is 10. Any custom value specified must lie between 0 and 100, inclusive.
        schema:
          type: number
      - name: after
        required: false
        in: query
        description: The cursor to start returning results from
        schema:
          type: string
      - name: sort
        required: false
        in: query
        description: The field used for sorting the results. If not provided, 'createdAt' will be used as the default sort field.
        schema:
          enum:
          - createdAt
          - revisionCreatedAt
          type: string
      - name: order
        required: false
        in: query
        description: The sort order used for the given sort field. If not provided, the default sort order is 'asc'.
        schema:
          enum:
          - asc
          - desc
          type: string
      - name: issuedBefore
        required: false
        in: query
        description: Filter to only results that have been issued (finalized and set to status OPEN) before this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.
        schema:
          format: utc-timestamp
          example: '2020-01-01T00:00:00.000Z'
          type: string
      - name: issuedAfter
        required: false
        in: query
        description: Filter to only results that have been issued (finalized and set to status OPEN) after this timestamp. This can be a UTC timestamp or a floating date. If a floating date is passed, the timestamp used will be the beginning (midnight UTC) of the date.
        schema:
          format: utc-timestamp
          example: '2020-01-01T00:00:00.000Z'
          type: string
      responses:
        '200':
          description: The paginated response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ReceivableInvoice'
                  pageInfo:
                    type: object
                    properties:
                      hasPreviousPage:
                        type: boolean
                      hasNextPage:
                        type: boolean
                      startCursor:
                        type: string
                      endCursor:
                        type: string
      summary: List receivable invoices
      tags:
      - receivable-invoices
  /v1/receivable-invoices/{qid}:
    get:
      description: Returns the receivable invoice with the specified QID.
      operationId: ReceivableInvoices_get
      parameters:
      - name: expand
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - lineItems.invoiceDeliveryMethod
            - shipments
            - shipments.exceptions
            - shipments.shipmentJobs
            - shipments.shipmentJobs.addresses
            - shipments.shipmentJobs.artifacts
            - shipments.shipmentJobs.jobTypeInfo.address
            - shipments.shipmentJobs.jobTypeInfo.organizations
            - shipments.shipmentJobs.jobTypeInfo.organizations.tags
            - shipments.shipmentJobs.organizations
            - shipments.shipmentJobs.organizations.tags
            - shipments.shipmentJobs.tags
            - supportingArtifacts
      - name: qid
        required: true
        in: path
        description: QID of the entity to retrieve
        schema:
          format: qid
          example: qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivableInvoice'
        '400':
          description: Invalid QID
      summary: Retrieve a receivable invoice
      tags:
      - receivable-invoices
    delete:
      description: Delete a draft receivable invoice. The operation will succeed if the invoice was already deleted or there is no AR invoice identified by the QID.
      operationId: ReceivableInvoices_delete
      parameters:
      - name: qid
        required: true
        in: path
        description: QID of the entity to delete
        schema:
          format: qid
          example: qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5
          type: string
      responses:
        '204':
          description: ''
      summary: Delete a draft receivable invoice
      tags:
      - receivable-invoices
  /v1/receivable-invoices/{qid}/void:
    put:
      description: Void an open receivable invoice. The operation will succeed if the invoice is already void.
      operationId: ReceivableInvoices_void
      parameters:
      - name: expand
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - lineItems.invoiceDeliveryMethod
            - shipments
            - shipments.exceptions
            - shipments.shipmentJobs
            - shipments.shipmentJobs.addresses
            - shipments.shipmentJobs.artifacts
            - shipments.shipmentJobs.jobTypeInfo.address
            - shipments.shipmentJobs.jobTypeInfo.organizations
            - shipments.shipmentJobs.jobTypeInfo.organizations.tags
            - shipments.shipmentJobs.organizations
            - shipments.shipmentJobs.organizations.tags
            - shipments.shipmentJobs.tags
            - supportingArtifacts
      - name: qid
        required: true
        in: path
        description: QID of the entity to void
        schema:
          format: qid
          example: qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c5
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivableInvoice'
      summary: Void an open receivable invoice
      tags:
      - receivable-invoices
components:
  schemas:
    CurrencyCode:
      type: string
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHF
      - CLP
      - CNY
      - COP
      - CRC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLE
      - SOS
      - SRD
      - SSP
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - UYU
      - UZS
      - VED
      - VES
      - VND
      - VUV
      - WST
      - XAF
      - XCD
      - XCG
      - XOF
      - XPF
      - YER
      - ZAR
      - ZMW
      - ZWG
    ShipmentJobAirAddress:
      type: object
      properties:
        type:
          type: string
          description: The type of address
          enum:
          - ORIGIN
          - DESTINATION
          example: ORIGIN
        name:
          type:
          - string
          - 'null'
          description: The name associated with this address
        addressQid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        address:
          description: The address details. This is an expansion field. To include this field, you must include `address` in the query parameters.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/Address'
      required:
      - type
      - name
      - addressQid
      - address
    ShipmentJobUnknownInfo:
      type: object
      properties:
        vendorOrganizationQid:
          type: string
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        vendorOrganization:
          description: The vendor associated with this job. This is an expansion field. To include this field, you must include `organization` in the query parameters.
          allOf:
          - $ref: '#/components/schemas/OrganizationExpanded'
      required:
      - vendorOrganizationQid
    NmfcClass:
      type: string
      enum:
      - '50'
      - '55'
      - '60'
      - '65'
      - '70'
      - '77.5'
      - '85'
      - '92.5'
      - '100'
      - '110'
      - '125'
      - '150'
      - '175'
      - '200'
      - '250'
      - '300'
      - '400'
      - '500'
    ShipmentJobFtlStopArticle:
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
        dimensions:
          example:
            height: '2.8'
            length: '12.1'
            width: '1.5'
            unit: INCH
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/Dimensions'
        grossWeight:
          example:
            amount: '20.2'
            unit: POUND
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/Weight'
        nmfcClass:
          allOf:
          - $ref: '#/components/schemas/NmfcClass'
        nmfcCode:
          type:
          - string
          - 'null'
          description: The raw NMFC code string associated with this article.
          example: '87700'
        packageCount:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/PackageCountInput'
        handlingUnit:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/HandlingUnit'
      required:
      - description
      - dimensions
      - grossWeight
      - nmfcClass
      - nmfcCode
      - packageCount
      - handlingUnit
    Volume:
      type: object
      properties:
        value:
          type: string
          format: decimal-string
          example: '1.5'
        unit:
          type: string
          enum:
          - CUBIC_CENTIMETER
          - CUBIC_FEET
          - CUBIC_INCH
          - CUBIC_METER
          example: CUBIC_FEET
      required:
      - value
      - unit
    ShipmentJobFtlStopReferenceNumber:
      type: object
      properties:
        key:
          type: string
          description: The type of reference number associated with this stop.
          enum:
          - APPOINTMENT_REFERENCE_NUMBER
          - BILLING_ACCOUNT_NUMBER
          - BOL_NUMBER
          - CARRIER_IDENTIFIER
          - CONSOLIDATED_INVOICE_NUMBER
          - CONTAINER_NUMBER
          - CUSTOMER_REFERENCE_NUMBER
          - DELIVERY_NUMBER
          - DESTINATION_LOCATION_NUMBER
          - DISPLAY_IDENTIFIER
          - EXTERNAL_IDENTIFIER
          - HAWB_NUMBER
          - HBL_NUMBER
          - INVOICE_NUMBER
          - MAWB_NUMBER
          - MBL_NUMBER
          - ORIGIN_LOCATION_NUMBER
          - PICKUP_CONFIRMATION_NUMBER
          - PICKUP_REFERENCE_NUMBER
          - PO_NUMBER
          - PRO_NUMBER
          - RAIL_WAYBILL_NUMBER
          - SALES_ORDER_NUMBER
          - SEA_WAYBILL_NUMBER
          - TRACKING_NUMBER
          - TRAILER_NUMBER
          - UNKNOWN
          example: PO_NUMBER
        value:
          type: string
          description: The value of the reference number associated with this stop.
          example: '123'
      required:
      - key
      - value
    ShipmentJobLtlInfo:
      type: object
      properties:
        billToAddressName:
          type:
          - object
          - 'null'
          description: The name associated with the bill to address on the job artifact
        billToAddressQid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        billToAddress:
          description: The bill to address on the job artifact This is an expansion field. To include this field, you must include `address` in the query parameters.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/Address'
        carrierOrganizationName:
          type:
          - string
          - 'null'
          description: The name of the carrier
        carrierOrganizationQid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        carrierOrganization:
          description: The carrier associated with this job. This is an expansion field. To include this field, you must include `organization` in the query parameters.
          allOf:
          - $ref: '#/components/schemas/OrganizationExpanded'
        brokerOrganizationQid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        brokerOrganization:
          description: The broker associated with this job. This is an expansion field. To include this field, you must include `organization` in the query parameters.
          allOf:
          - $ref: '#/components/schemas/OrganizationExpanded'
        freightChargeTerms:
          allOf:
          - $ref: '#/components/schemas/FreightChargeTerms'
        originAddressName:
          type:
          - object
          - 'null'
          description: The name associated with the origin address
        originAddressQid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        originAddress:
          description: The origin address of the shipment. This is an expansion field. To include this field, you must include `address` in the query parameters.
          allOf:
          - $ref: '#/components/schemas/Address'
        pickupDate:
          type:
          - string
          - 'null'
          format: floating-date
          example: '2023-01-01'
        destinationAddressName:
          type:
          - object
          - 'null'
          description: The name associated with the destination address
        destinationAddressQid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        destinationAddress:
          description: The destination address of the shipment. This is an expansion field. To include this field, you must include `address` in the query parameters.
          allOf:
          - $ref: '#/components/schemas/Address'
        deliveryDate:
          type:
          - string
          - 'null'
          format: floating-date
          example: '2023-01-01'
        articlesSummary:
          $ref: '#/components/schemas/ShipmentJobArticlesSummary'
        articles:
          type: array
          items:
            $ref: '#/components/schemas/ShipmentJobLtlInfoArticle'
      required:
      - billToAddressName
      - billToAddressQid
      - carrierOrganizationName
      - carrierOrganizationQid
      - brokerOrganizationQid
      - freightChargeTerms
      - originAddressName
      - originAddressQid
      - pickupDate
      - destinationAddressName
      - destinationAddressQid
      - deliveryDate
      - articlesSummary
      - articles
    ReceivableInvoice:
      type: object
      properties:
        qid:
          type: string
          description: Qualified unique identifier.
          format: qid
          example: qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4
        createdAt:
          type: string
          format: utc-timestamp
          example: '2023-01-01T00:00:00.000Z'
        revisionNumber:
          type: number
          example: 1
        revisionCreatedAt:
          type: string
          format: utc-timestamp
          example: '2023-01-01T00:00:00.000Z'
        invoiceNumber:
          type: string
          description: The invoice number
          example: 555-555555
        payorOrganizationQid:
          type: string
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        payeeOrganizationQid:
          type: string
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        status:
          type: string
          enum:
          - DRAFT
          - OPEN
          - VOID
          - PAID
        noteToPayor:
          type: string
          example: This is a payor note.
          description: The note to the payor. This is the note that gets included in the generated AR invoice.
        note:
          type:
          - string
          - 'null'
          example: This is an internal note.
          description: The internal note on the invoice.
        issuedAt:
          type:
          - string
          - 'null'
          format: utc-timestamp
          example: '2023-01-01T00:00:00.000Z'
          description: When the draft version of this invoice was finalized.
        dueDate:
          type:
          - string
          - 'null'
          format: floating-date
          example: '2023-01-01'
          description: The date the invoice is due.
        total:
          example:
            amount: '3.50'
            currencyCode: USD
          description: The total amount invoiced.
          allOf:
          - $ref: '#/components/schemas/Money'
        adjustmentSubtotal:
          example:
            amount: '3.50'
            currencyCode: USD
          description: The total amount invoiced from ADJUSTMENT line items.
          allOf:
          - $ref: '#/components/schemas/Money'
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/ReceivableInvoiceLineItem'
        supportingArtifacts:
          description: Supporting artifacts attached to the receivable invoice. This is an expansion field. To include this field, you must include `supportingArtifacts` in the query parameters.
          allOf:
          - $ref: '#/components/schemas/ArtifactExpanded'
        shipments:
          description: Shipments related to the receivable invoice. This is an expansion field. To include this field, you must include `shipments` in the query parameters.
          allOf:
          - $ref: '#/components/schemas/ShipmentExpanded'
        exceptions:
          description: The exceptions related to the receivable invoice. This is an expansion field. To include this field, you must include `exceptions` in the query parameters.
          type: array
          items:
            $ref: '#/components/schemas/BusinessException'
        finalizedAt:
          type:
          - string
          - 'null'
          format: utc-timestamp
          example: '2023-01-01T00:00:00.000Z'
          description: The date the invoice was finalized.
        finalizedBy:
          description: The user who finalized the invoice. This is an expansion field. To include this field, you must include `finalizedBy` in the query parameters.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/User'
        voidReason:
          example: INTERNAL_PRICING_ERROR
          allOf:
          - $ref: '#/components/schemas/ReceivableInvoiceVoidReasonType'
        voidReasonNote:
          type: string
          example: Invoice voided due to error
          description: Additional information about why the invoice was voided.
      required:
      - qid
      - createdAt
      - revisionNumber
      - revisionCreatedAt
      - invoiceNumber
      - payorOrganizationQid
      - payeeOrganizationQid
      - status
      - noteToPayor
      - note
      - issuedAt
      - dueDate
      - total
      - adjustmentSubtotal
      - lineItems
    Address:
      type: object
      properties:
        qid:
          type: string
          description: Qualified unique identifier.
          example: qid::address:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        addressLine1:
          type: string
          example: 123 Main Street
        addressLine2:
          type: string
          example: Suite 456
        city:
          type: string
          example: Chicago
        state:
          type: string
          example: IL
        postalCode:
          type: string
          example: '60601'
        country:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 country code.
      required:
      - qid
      - addressLine1
      - city
      - postalCode
      - country
    OrganizationExpanded:
      type: object
      properties:
        qid:
          type: string
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        displayName:
          type: string
          example: ACME
          description: Name of the organization.
        tags:
          type: object
          description: Entity tags associated with the organization
          example:
            externalCarrierUuid: 304fb3dd-1f4a-404b-9f9e-c9134584915b
      required:
      - qid
      - displayName
    PackageCountInput:
      type: object
      properties:
        amount:
          type: integer
          example: 8
        unit:
          type: string
          enum:
          - BAG
          - BALE
          - BOX
          - BUNDLE
          - CARTON
          - CASE
          - COIL
          - EACH
          - PACKAGE
          - PAIL
          - PIECE
          - ROLL
          - SQUARE
          - TOTE
          - TUBE
          example: CARTON
      required:
      - amount
      - unit
    ShipmentJobAirDate:
      type: object
      properties:
        qid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::shipment_job_air_date:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        dateType:
          type: string
          description: The type of date
          enum:
          - EXECUTED
          - FLIGHT_DEPARTURE
          - FLIGHT_ARRIVAL
          - ESTIMATED_ARRIVAL
          - DELIVERY
          example: FLIGHT_DEPARTURE
        date:
          type: string
          format: floating-date
          example: '2023-01-01'
        iataCode:
          type:
          - string
          - 'null'
          description: The IATA airport code for this date if applicable (e.g. departure airport).
      required:
      - qid
      - dateType
      - date
      - iataCode
    ShipmentJobArtifactExpanded:
      type: object
      properties:
        qid:
          type: string
          description: Qualified unique identifier.
          example: qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        artifactType:
          type: string
          description: Domain-specific type of the artifact.
          enum:
          - ACCOUNT_STATEMENT
          - BILL_OF_LADING
          - CUSTOMER_RATE_CONFIRMATION
          - DELIVERY_ORDER
          - DELIVERY_RECEIPT
          - EXTERNAL_SHIPMENT_NOTE
          - INVOICE
          - IN_OUT_GATE
          - LUMPER_RECEIPT
          - OTHER
          - PACKET
          - PACKING_LIST
          - RATE_CONFIRMATION
          - SCALE_TICKET
          - SHIPMENT_RECORD
          - UNKNOWN
          - WASHOUT_RECEIPT
          - WEIGHT_INSPECTION
          - WORK_ORDER
          example: INVOICE
        assessedTypes:
          type: array
          description: The artifact's assessed types
          example:
          - PROOF_OF_DELIVERY
          items:
            type: string
            enum:
            - PROOF_OF_DELIVERY
        receivedAt:
          type: string
          format: utc-timestamp
          example: '2023-01-01T00:00:00.000Z'
          description: When the artifact was first ingested into Loop.
      required:
      - qid
      - artifactType
      - assessedTypes
      - receivedAt
    BusinessException:
      type: object
      properties:
        qid:
          type: string
          description: Qualified unique identifier.
          example: qid::business_exception:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        label:
          type: string
          description: The description of the business exception
          example: Variance over threshold
        resolvedAt:
          type:
          - string
          - 'null'
          format: utc-timestamp
          example: '2023-01-01T00:00:00.000Z'
          description: If resolved, the time the exception was resolved. If the exception was resolved and re-opened, this will be null.
        targetQid:
          type: string
          description: Qualified unique identifier of the business exception's target entity.
          format: qid
          example: qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4
        note:
          type:
          - string
          - 'null'
          description: The note on the business exception
      required:
      - qid
      - label
      - resolvedAt
      - targetQid
    ShipmentJobGenericV1Info:
      type: object
      properties:
        vendorOrganizationQid:
          type: string
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
      required:
      - vendorOrganizationQid
    ShipmentJobOceanDate:
      type: object
      properties:
        qid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::shipment_job_ocean_date:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        dateType:
          type: string
          description: The type of date
          enum:
          - CARGO_RECEIVED
          - LADEN_ON_BOARD
          - DEPARTURE
          - ESTIMATED_ARRIVAL
          - ARRIVAL
          - DISCHARGE
          - DELIVERY
          example: LADEN_ON_BOARD
        date:
          type: string
          format: floating-date
          example: '2023-01-01'
        unlocode:
          type:
          - string
          - 'null'
          description: The UN/LOCODE for this date if applicable (e.g. port of laden-on-board)
      required:
      - qid
      - dateType
      - date
      - unlocode
    ShipmentJobOceanContainer:
      type: object
      properties:
        qid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::shipment_job_ocean_container:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        containerNumber:
          type:
          - string
          - 'null'
          description: The container number
          example: MSKU1234567
        containerType:
          type:
          - string
          - 'null'
          description: The type of container
          enum:
          - GP20
          - GP40
          - HC40
          - HC45
          - RF20
          - RF40
          - RF40HC
          - OT20
          - OT40
          - FR20
          - FR40
          - TK20
          example: GP20
      required:
      - qid
      - containerNumber
      - containerType
    ShipmentJobAirInfo:
      type: object
      properties:
        carrierOrganizationName:
          type:
          - string
          - 'null'
          description: The name of the carrier
        carrierOrganizationQid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        carrierOrganization:
          description: The carrier associated with this job. This is an expansion field. To include this field, you must include `organization` in the query parameters.
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/OrganizationExpanded'
        forwarderOrganizationName:
          type:
          - string
          - 'null'
          description: The name of the forwarder
        forwarderOrganizationQid:
          type:
          - string
          - 'null'
          description: Qualified unique identifier.
          example: qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4
          format: qid
        forwarderOrganization:
          

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/loop/refs/heads/main/openapi/loop-receivable-invoices-api-openapi.yml