Retrieve payment records with transaction details and security compliance

This endpoint provides secure payment data access with:

• PCI-compliant payment information (masked card data)
• Payment method categorization and tracking
• Integration with AR transactions for complete context
• Payment processor integration (PayPal, Stripe, etc.)
• Date-based filtering for reconciliation periods
• Client relationship data for payment attribution

Security & Compliance:

• PCI DSS compliant data handling (last 4 digits only)
• Secure payment processor ID tracking
• Payment confirmation date logging
• Audit trail for payment processing

Payment Method Support:

• Credit/debit card payments with masked PAN
• ACH/bank transfer processing
• Check and wire transfer tracking
• Digital wallet integration (PayPal, Apple Pay, etc.)

Reconciliation Features:

• Payment-to-invoice matching via AR transactions
• Payment confirmation status tracking
• Processor reference ID management
• Multi-currency payment support

Business Applications:

• Payment reconciliation and matching
• Revenue recognition and cash flow analysis
• Client payment history and patterns
• Payment method performance analysis
• Compliance reporting and audit trails

Real Example:

curl --location 'https://{{host}}/v1/payments' \
--header 'Authorization: bearer {{token}} \
--header 'Content-Type: application/json' \
--data '{
  "pageSize": 25,
  "page": 0
}'

Advanced payment filtering with custom GraphQL where clauses and dynamic ordering

Backed by view vw_payment_history_firm_table. Supports text matching, date ranges, and flags.

Real Example:

curl --location 'https://{{host}}/v1/payments/search' \
--header 'Authorization: bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
  "pageSize": 1,
  "where": {
    "_and": [
      {
        "_or": [
          {
            "paymentMethod": {
              "_ilike": "%CREDIT%"
            }
          },
          {
            "cardType": {
              "_ilike": "%VISA%"
            }
          }
        ]
      },
      {
        "isAutomatic": {
          "_eq": false
        }
      },
      {
        "createdAt": {
          "_gte": "1900-01-01T00:00:00Z"
        }
      },
      {
        "paymentConfirmationDate": {
          "_is_null": false
        }
      }
    ]
  },
  "orderBy": [
    {
      "paymentConfirmationDate": "desc"
    },
    {
      "createdAt": "desc"
    }
  ]
}'

Retrieve a specific payment by its unique identifier

This endpoint provides detailed payment information including:

• Complete payment transaction details
• PCI-compliant payment method information (masked)
• Payment status and confirmation data
• Associated invoice and client relationships
• Payment processor integration details
• Audit trail and security compliance data

Security & Compliance:

• PCI DSS compliant data handling
• Secure payment processor ID tracking
• Payment confirmation date logging
• Audit trail for payment processing

Payment Details Include:

• Payment amount and currency
• Payment method (masked for security)
• Payment status and confirmation
• Associated invoice references
• Client relationship data
• Payment processor details

Business Applications:

• Payment verification and reconciliation
• Client payment history lookup
• Payment dispute resolution
• Audit and compliance reporting
• Payment method analysis

Real Example:

curl --location 'https://{{host}}/v1/payment/12345' \
--header 'Authorization: bearer {{token}}' \
--header 'Content-Type: application/json'

Response Example:

{
  "id": 12345,
  "amount": 1500.00,
  "currency": "USD",
  "paymentMethod": "CREDIT_CARD",
  "cardLastFour": "1234",
  "cardType": "VISA",
  "status": "CONFIRMED",
  "confirmationDate": "2024-01-15T10:30:00Z",
  "processorReference": "stripe_pi_1234567890",
  "clientId": 789,
  "clientName": "Acme Corporation",
  "invoiceId": 456,
  "invoiceNumber": "INV-2024-001",
  "createdAt": "2024-01-15T10:25:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}