---
title: "Create Invoice Payment"
method: POST
path: "/api/v1/Invoices/paidpayment"
tags: ["Invoices"]
---

# Create Invoice Payment

`POST /api/v1/Invoices/paidpayment`

## Request

- Base URL: `https://api.peakaccount.com`
- URL: `https://api.peakaccount.com/api/v1/Invoices/paidpayment`
- Auth: none declared. Required headers: `Time-Stamp`, `Time-Signature`, `User-Token`, `Client-Token`
- TypeScript: <https://skmtc.dev/peakaccount/apis/peakapis-core/docs/api/v1/Invoices/paidpayment/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `Time-Stamp` string, required
- `Time-Signature` string, required
- `User-Token` string, required
- `Client-Token` string, required

## Request body

- object
  - `peakPaidPayments` object, required
    - `transactionTypeId` integer: Numeric code to indicate the document type
    - `transactionId` string: The Unique Identifier of the document for which payment is requested (Required if transactionCode is not provided)
    - `transactionCode` string: The Code of the document for which payment is requested (Required if transactionId is not provided)
    - `paymentDate` string, required: Payment date in the format yyyyMMdd
    - `withholdingTaxAmount` string: Withholding tax deducted from this payment, as an amount (e.g. "30") or a percentage (e.g. "3%")
    - `payments` object[], required
      - `paymentMethodId` string: The Unique Identifier of the payment method
      - `paymentMethodCode` string: Code of the payment method (If paymentMethodId has been assigned a value, paymentMethodCode is not required)
      - `accountCode` string: Account code to be used for recording financial transactions
      - `accountSubId` string: Sub account Unique Identifier to be used for recording financial transactions
      - `accountSubCode` string: Sub account code to be used for recording financial transactions
      - `amount` number, double, required: Payment amount
      - `note` string: Additional remarks or notes for that specific payment received

## Response `200`

Success

- PeakWCFModelsAPIResponseResponsePaidPaymentsModel
  - `peakPaidPayments` PeakWCFModelsAPIBodyAPIBodyPaidPayment
    - `resCode` string
    - `resDesc` string
    - `transactionId` string
    - `transactionCode` string
    - `paidPayments` PeakWCFModelsAPIAPITransactionsAPITransactionPayments
      - `id` string
      - `paymentDate` string
      - `withHoldingTaxAmount` string
      - `paymentGroupId` integer
      - `paymentTotal` number, double
      - `payments` PeakWCFModelsAPIAPITransactionsAPITransactionPaymentLists[]
        - `paymentMethodId` string
        - `paymentMethodCode` string
        - `accountCode` string
        - `accountSubId` string
        - `accountSubCode` string
        - `amount` number, double
        - `note` string
        - `isCheque` integer
        - `cheque` PeakWCFModelsAPIAPITransactionsAPITransactionChequePayment
          - `chequeDate` string
          - `paymentMethodId` string
          - `paymentMethodCode` string
          - `bankId` integer
          - `bankName` string
          - `amount` number, double
          - `chequeNo` string
          - `branchNo` string
          - `accountNo` string
          - `isDeposited` integer
      - `journals` PeakWCFModelsAPIAPITransactionsAPITransactionJournals[]
        - `id` string
        - `code` string
      - `referenceCode` string
      - `referenceId` string
      - `referenceType` string
    - `paymentAmount` number, double
    - `remainPaymentAmount` number, double
    - `remainWhtAmount` number, double
  - `eventType` string
  - `apiType` string

## Changes

- **2026-11-03** `433c913c750f`: 7 breaking
  - removed the media type `application/*+json` from the request body
  - removed the media type `application/json-patch+json` from the request body
  - removed the media type `text/json` from the request body
  - the request property `peakPaidPayments` became required
  - …3 more

[Operation history](https://skmtc.dev/peakaccount/apis/peakapis-core/changes/api/v1/Invoices/paidpayment/post.md)

---

[API](https://skmtc.dev/peakaccount/apis/peakapis-core.md) - [All operations](https://skmtc.dev/peakaccount/apis/peakapis-core/llms.txt) - [OpenAPI document](https://skmtc.dev/peakaccount/apis/peakapis-core/revisions/433c913c750f?raw)