PartnerScheduleDetailModel

  • amountExclTax
    Type: numberFormat: double

    The total transaction amount excluding tax.

  • date
    Type: stringFormat: date

    The date of the schedule.

  • description
    Type: string | null

    The description of schedule.

  • id
    Type: stringFormat: uuid

    The ID of the schedule.

  • isExported
    Type: boolean

    Whether or not the schedule has been exported for the current api connection

  • partner
    Type: object
    • code
      Type: string | null

      The code of the partner.

    • email
      Type: string | null

      The email address of the partner.

    • externalId
      Type: string | null

      The external ID of the partner.

    • id
      Type: stringFormat: uuid

      The ID of the partner.

    • name
      Type: string | null

      The name of the partner.

    • relationship
      Type: integerenum

      Integer numbers.

      values
      • Client = 1
      • Carrier = 2
    • status
      Type: integerenum

      Integer numbers.

      values
      • Inactive = 1
      • Active = 2
  • referenceNumber
    Type: string | null

    The reference number of schedule.

  • transactions
    Type: array object[] | null ยท PartnerTransactionHeaderModel[]

    The transactions included in the schedule.

    • activityCode
      Type: string | null

      The activity code of the transaction.

    • activityName
      Type: string | null

      The activity name of the transaction.

    • amountExclTax
      Type: numberFormat: double

      The amount, exlcuding tax, of the transaction.

    • baseChargeExclTax
      Type: number | nullFormat: double

      The base charge, exlcuding tax, of the transaction.

    • chargeApplication
      Type: integerenum

      Integer numbers.

      values
      • Rate = 1
      • Fee = 2
    • chargeRateExclTax
      Type: numberFormat: double

      The charge rate, exlcuding tax, of the transaction.

    • chargeTypeCode
      Type: string | null

      The code of the charge type.

    • chargeTypeId
      Type: string | nullFormat: uuid

      The ID of the charge type.

    • chargeTypeName
      Type: string | null

      The name of the charge type.

    • consignmentId
      Type: string | nullFormat: uuid

      The ID of the consignment.

    • consignmentNumber
      Type: string | null

      The consignment number.

    • consignmentReferenceNumber
      Type: string | null

      The consignment reference number.

    • costCentreCode
      Type: string | null

      The cost centre code of the transaction.

    • costCentreId
      Type: string | nullFormat: uuid

      The cost centre id of the transaction.

    • date
      Type: stringFormat: date

      The date of the transaction.

    • id
      Type: stringFormat: uuid

      The ID of the transaction.

    • maxChargeExclTax
      Type: number | nullFormat: double

      The max charge, exlcuding tax, of the transaction.

    • minChargeExclTax
      Type: number | nullFormat: double

      The min charge, exlcuding tax, of the transaction.

    • particulars
      Type: string | null

      The particulars of the transaction.

    • quantity
      Type: numberFormat: double

      The quantity of the transaction.

    • revenueAccountCode
      Type: string | null

      The revenue account code of the transaction.

    • revenueAccountId
      Type: string | nullFormat: uuid

      The revenue account id of the transaction.

    • taxRateId
      Type: stringFormat: uuid

      The ID of the tax rate.

    • taxRateName
      Type: string | null

      The name of the tax rate.

    • taxRatePercent
      Type: numberFormat: double

      The percent of the tax rate.

    • type
      Type: integerenum

      Integer numbers.

      values
      • AdhocCharge = 0
      • FreightCharge = 1
      • StorageCharge = 2
      • ActivityCharge = 3