financial-transaction.yaml

FinancialTransaction:
  description: |
    A type of Transaction that records non-sale transfer of funds to/from retailer.
    Financial transaction records movement of money, typically cash, in/out of
    Till inside POS associated with non-sale activities. Based on the type of
    such money transfer, it could be mapped to a financial transaction inside
    retailer's accounting system.
    It includes activities such as paidIn and paidOut
  type: object
  properties:
    typeCode:
      description: |
        A code that describes the type of the Financial Transaction.
        This type describes the transfer of funds. For exmple it could be
        PaidOut to buy some stationery or collecting donations as part of
        a fundraiser.
      $ref: "#/FinancialTransactionTypeCodeEnum"
    accountableAssociate:
      description: |
        Associate accountable for the funds in financial transaction.
        It could be different from the performing associate.
        For example, if funds were given to a particular associate to
        make some purchase associate information can be captured here.
      $ref: ./Associate.v1.yaml
    tillID:
      description: |
        An ID for the till associated with the financial transaction.
        Till is a tender repository that is assigned a unique
        ID within a business unit (e.g. a store). It can be moved around
        the business unit and can be inserted inside a cash drawer.
      type: string
    tillNumber:
      description: |
        A unique identifier for the till within store.
        This is unique per business unit, meaningful number.
      type: integer
      format: int32
    cashDrawerID:
      description: |
        Cash drawer identifier captured as part of financial transaction
      type: string
    lineItems:
      description: |
        Line items within financial transaction.
      $ref: "financial-transaction-lineitem.yaml#/FinancialTransactionLineItemCollection"
    controlledOperation:
      description: |
        Additional control information about Financial Transaction.
      $ref: "common.yaml#/ControlledOperation"
    voidedInProcessFlag:
      description: |
        A flag that indicates that the Financial Transaction was voided in
        process. It means that there was no transfer of funds.
      type: boolean
      default: false
    voidInProcess:
      description: |
        Details of the Financial Transaction void in process operation.
      $ref: "void.yaml#/Void"
  additionalProperties: false

FinancialTransactionTypeCodeEnum:
  description: |
    Type code that indicates the type of financial transaction.
  type: string
  enum:
    - PaidIn
    - PaidOut
    - Unknown