---
title: "GET /billing/{tenantLocator}/payments/{locator}/previewValidate"
method: GET
path: "/billing/{tenantLocator}/payments/{locator}/previewValidate"
---

# GET /billing/{tenantLocator}/payments/{locator}/previewValidate

`GET /billing/{tenantLocator}/payments/{locator}/previewValidate`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/billing/{tenantLocator}/payments/{locator}/previewValidate`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/billing/:tenantLocator/payments/:locator/previewValidate/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required
- `locator` string, ulid, required

## Response `200`

OK

- PreviewPaymentResponse
  - `locator` string, ulid, required
  - `paymentState` 'draft' | 'validated' | 'requested' | 'executing' | 'posting' | 'posted' | 'failed' | 'cancelled' | 'reversing' | 'reversed' | 'discarded', required
  - `type` string, required
  - `currency` string, required
  - `amount` number, required
  - `data` object, required
  - `createdAt` string, date-time, required
  - `createdBy` string, uuid, required
  - `accountLocator` string, ulid
  - `remainingAmount` number
  - `externalCashTransactionLocator` string, ulid
  - `validationResult` ValidationResult
    - `validationItems` ValidationItemResponse[]
      - `elementType` string, required
      - `locator` string, ulid, required
      - `errors` string[], required
    - `success` boolean, required
  - `postedAt` string, date-time
  - `paymentMode` 'normal' | 'aggregate'
  - `aggregatePaymentLocator` string, ulid
  - `targets` CreditItem[], required
    - `containerLocator` string, ulid, required
    - `containerType` 'invoice' | 'account' | 'subpayment' | 'invoiceItem', required
    - `amount` number
  - `credits` CreditWithBalance[], required
    - `type` 'accountCreditBalance' | 'invoiceCreditBalance' | 'cash' | 'creditCash' | 'charge' | 'credit' | 'installmentItem' | 'invoiceItem' | 'account' | 'policy' | 'accountExpenseBalance', required
    - `locator` string, ulid, required
    - `amount` number, required
  - `shortfallCredits` ShortfallCreditPreviewResponse[], required
    - `locator` string, ulid, required
    - `creditType` 'creditDistribution' | 'disbursement' | 'payment' | 'subpayment' | 'shortfallWriteOff' | 'writeOff', required
    - `shortfallCreditState` 'draft' | 'distributed' | 'reversed', required
    - `currency` string, required
    - `amount` number, required
    - `accountLocator` string, ulid, required
    - `targets` CreditItem[], required
      - `containerLocator` string, ulid, required
      - `containerType` 'invoice' | 'account' | 'subpayment' | 'invoiceItem', required
      - `amount` number
  - `subpayments` PreviewPaymentResponse[]
  - `invoices` ListPageResponseInvoicePaymentPreview
    - `listCompleted` boolean, required
    - `items` InvoicePaymentPreview[], required
      - `locator` string, ulid, required
      - `accountLocator` string, ulid, required
      - `invoiceState` 'building' | 'open' | 'settled' | 'discarded', required
      - `amount` number
      - `remainingAmount` number

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)