invoiceninja/openapi/components/schemas/payment.yaml

    Payment:
      properties:
        id:
          description: 'The payment hashed id'
          type: string
          example: Opnel5aKBz
        client_id:
          description: 'The client hashed id'
          type: string
          example: Opnel5aKBz
        invitation_id:
          description: 'The invitation hashed id'
          type: string
          example: Opnel5aKBz
        client_contact_id:
          description: 'The client contact hashed id'
          type: string
          example: Opnel5aKBz
        user_id:
          description: 'The user hashed id'
          type: string
          example: Opnel5aKBz
        type_id:
          $ref: '#/components/schemas/PaymentType'
        date:
          description: 'The Payment date'
          type: string
          example: 1-1-2014
        transaction_reference:
          description: 'The transaction reference as defined by the payment gateway'
          type: string
          example: xcsSxcs124asd
        assigned_user_id:
          description: 'The assigned user hashed id'
          type: string
          example: Opnel5aKBz
        private_notes:
          description: 'The private notes of the payment'
          type: string
          example: 'The payment was refunded due to error'
        is_manual:
          description: 'Flags whether the payment was made manually or processed via a gateway'
          type: boolean
          example: true
        is_deleted:
          description: 'Defines if the payment has been deleted'
          type: boolean
          example: true
        amount:
          description: 'The amount of this payment'
          type: number
          example: 10
        refunded:
          description: 'The refunded amount of this payment'
          type: number
          example: 10
        updated_at:
          description: Timestamp
          type: number
          format: integer
          example: '1434342123'
        archived_at:
          description: Timestamp
          type: number
          format: integer
          example: '1434342123'
        company_gateway_id:
          description: 'The company gateway id'
          type: string
          example: '3'
        paymentables:
          $ref: '#/components/schemas/Paymentable'
        invoices:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/InvoicePaymentable'
        credits:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/CreditPaymentable'
        number:
          description: 'The payment number - is a unique alpha numeric number per payment per company'
          type: string
          example: PAY_101
        category_id:
          description: 'The unique identifier of the payment category'
          type: string
          example: Opnel5aKBz
        custom_value1:
          description: 'Custom field for storing additional information'
          type: string
          example: 'Payment reference 123'
        custom_value2:
          description: 'Custom field for storing additional information'
          type: string
          example: 'Approved by John'
        custom_value3:
          description: 'Custom field for storing additional information'
          type: string
          example: 'Urgent payment'
        custom_value4:
          description: 'Custom field for storing additional information'
          type: string
          example: 'Q1 2024'
        exchange_currency_id:
          description: 'The unique identifier of the exchange currency'
          type: string
          example: '2'
        exchange_rate:
          description: 'The exchange rate used for currency conversion'
          type: number
          format: float
          example: 1.0
        idempotency_key:
          description: 'Unique key to ensure idempotent payment processing'
          type: string
          example: 'key_1234567890abcdef'
      type: object