---
title: "Created a new payment"
method: POST
path: "/api/payment"
tags: ["Payment"]
---

# Created a new payment

`POST /api/payment`

## Request body

- PaymentDTODetail
  - `saleDocumentPayments` SaleDocumentPaymentRef[] — A list of the invoices this payment was applied to.
    - `guid` string, uuid
    - `amount` number, double, required — The amount of payment or credit applied on this invoice
    - `saleDocument` SaleDocumentRef
      - `guid` string, uuid
      - `number` integer
      - `name` string — 
      - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote
      - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice.
      - `date` string, date-time, required — The issue date for this invoice / quote.
    - `payment` PaymentRef
      - `guid` string, uuid
      - `amount` number, double, required — The total amount received.
      - `name` string — 
      - `date` string, date-time, required
      - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry', required
      - `methodName` string
    - `credit` CreditRef
      - `guid` string, uuid
      - `creditAmount` number, double — Total credit amount Total credit amount
      - `creditApplied` number, double — Credit amount applied towards invoices Credit amount applied towards invoices
      - `creditAvailable` number, double — Credit amount available (not applied towards invoices) Credit amount available (not applied towards invoices)
      - `creditForSaleDocument` SaleDocumentRef, required
        - `guid` string, uuid
        - `number` integer
        - `name` string — 
        - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote
        - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice.
        - `date` string, date-time, required — The issue date for this invoice / quote.
  - `lastModifiedBy` UserRef
    - `guid` string, uuid
    - `displayName` string — 
    - `name` string — 
    - `timeZoneId` string
  - `lastModifiedDate` string, date-time — 
  - `projectGuid` string, uuid — Used to set the reference in POST and PUT
  - `accountGuid` string, uuid, required — Used to set the reference in POST and PUT
  - `authNumber` string — Authorization number for online payments
  - `bankAccountGuid` string, uuid, required — Used to set the reference in POST and PUTOnly operating account payments can be applied towards invoices. Only operating account payments can be applied towards invoices.
  - `accountTags` TagDTO[]
    - `name` string, required
  - `projectTags` TagDTO[]
    - `name` string, required
  - `account` AccountRef
    - `nameAndNumber` string — 
    - `guid` string, uuid
    - `utbmsIsEnabled` boolean
    - `id` integer
  - `checkPayee` AccountRef
    - `nameAndNumber` string — 
    - `guid` string, uuid
    - `utbmsIsEnabled` boolean
    - `id` integer
  - `project` ProjectRef
    - `nameAndNumber` string — This is a read only property This is a read only property
    - `guid` string, uuid
    - `accountGuid` string, uuid — Used to set the reference in POST and PUT
    - `id` integer
  - `createdBy` UserRef
    - `guid` string, uuid
    - `displayName` string — 
    - `name` string — 
    - `timeZoneId` string
  - `createdDate` string, date-time — 
  - `notes` string
  - `number` integer — 
  - `currencyCode` string, required — This defines the currency for this account. Must be in ISO 4217 format. Must match the currency code for the Account (contact).
  - `amountApplied` number, double — The portion of the payment already applied towards invoices. The portion of the payment already applied towards invoices.
  - `amountCredited` number, double — The portion of the payment not yet applied towards invoices. The portion of the payment not yet applied towards invoices.
  - `transactionId` string — Used to reference a transaction from an external gateway (ie. Stripe, PayPal, Auth.Net etc.)
  - `bankAccount` BankAccountRef
    - `guid` string, uuid
    - `name` string, required
    - `type` 'Operating' | 'Trust' | 'CreditCard'
    - `isArchived` boolean
  - `isReconciled` boolean
  - `reconciledDate` string, date-time
  - `reconciledBy` UserRef
    - `guid` string, uuid
    - `displayName` string — 
    - `name` string — 
    - `timeZoneId` string
  - `checkIsPrinted` boolean
  - `isDepositSlipPrinted` boolean
  - `checkNumber` integer
  - `feeAmountInCents` number, double
  - `refundParentPaymentGuid` string, uuid — Used to set the reference in POST and PUT
  - `surchargeAmount` number, double
  - `totalAmount` number, double
  - `guid` string, uuid
  - `amount` number, double, required — The total amount received.
  - `name` string — 
  - `date` string, date-time, required
  - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry', required
  - `methodName` string

## Response `200`

OK

- PaymentDTODetail
  - `saleDocumentPayments` SaleDocumentPaymentRef[] — A list of the invoices this payment was applied to.
    - `guid` string, uuid
    - `amount` number, double, required — The amount of payment or credit applied on this invoice
    - `saleDocument` SaleDocumentRef
      - `guid` string, uuid
      - `number` integer
      - `name` string — 
      - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote
      - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice.
      - `date` string, date-time, required — The issue date for this invoice / quote.
    - `payment` PaymentRef
      - `guid` string, uuid
      - `amount` number, double, required — The total amount received.
      - `name` string — 
      - `date` string, date-time, required
      - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry', required
      - `methodName` string
    - `credit` CreditRef
      - `guid` string, uuid
      - `creditAmount` number, double — Total credit amount Total credit amount
      - `creditApplied` number, double — Credit amount applied towards invoices Credit amount applied towards invoices
      - `creditAvailable` number, double — Credit amount available (not applied towards invoices) Credit amount available (not applied towards invoices)
      - `creditForSaleDocument` SaleDocumentRef, required
        - `guid` string, uuid
        - `number` integer
        - `name` string — 
        - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote
        - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice.
        - `date` string, date-time, required — The issue date for this invoice / quote.
  - `lastModifiedBy` UserRef
    - `guid` string, uuid
    - `displayName` string — 
    - `name` string — 
    - `timeZoneId` string
  - `lastModifiedDate` string, date-time — 
  - `projectGuid` string, uuid — Used to set the reference in POST and PUT
  - `accountGuid` string, uuid, required — Used to set the reference in POST and PUT
  - `authNumber` string — Authorization number for online payments
  - `bankAccountGuid` string, uuid, required — Used to set the reference in POST and PUTOnly operating account payments can be applied towards invoices. Only operating account payments can be applied towards invoices.
  - `accountTags` TagDTO[]
    - `name` string, required
  - `projectTags` TagDTO[]
    - `name` string, required
  - `account` AccountRef
    - `nameAndNumber` string — 
    - `guid` string, uuid
    - `utbmsIsEnabled` boolean
    - `id` integer
  - `checkPayee` AccountRef
    - `nameAndNumber` string — 
    - `guid` string, uuid
    - `utbmsIsEnabled` boolean
    - `id` integer
  - `project` ProjectRef
    - `nameAndNumber` string — This is a read only property This is a read only property
    - `guid` string, uuid
    - `accountGuid` string, uuid — Used to set the reference in POST and PUT
    - `id` integer
  - `createdBy` UserRef
    - `guid` string, uuid
    - `displayName` string — 
    - `name` string — 
    - `timeZoneId` string
  - `createdDate` string, date-time — 
  - `notes` string
  - `number` integer — 
  - `currencyCode` string, required — This defines the currency for this account. Must be in ISO 4217 format. Must match the currency code for the Account (contact).
  - `amountApplied` number, double — The portion of the payment already applied towards invoices. The portion of the payment already applied towards invoices.
  - `amountCredited` number, double — The portion of the payment not yet applied towards invoices. The portion of the payment not yet applied towards invoices.
  - `transactionId` string — Used to reference a transaction from an external gateway (ie. Stripe, PayPal, Auth.Net etc.)
  - `bankAccount` BankAccountRef
    - `guid` string, uuid
    - `name` string, required
    - `type` 'Operating' | 'Trust' | 'CreditCard'
    - `isArchived` boolean
  - `isReconciled` boolean
  - `reconciledDate` string, date-time
  - `reconciledBy` UserRef
    - `guid` string, uuid
    - `displayName` string — 
    - `name` string — 
    - `timeZoneId` string
  - `checkIsPrinted` boolean
  - `isDepositSlipPrinted` boolean
  - `checkNumber` integer
  - `feeAmountInCents` number, double
  - `refundParentPaymentGuid` string, uuid — Used to set the reference in POST and PUT
  - `surchargeAmount` number, double
  - `totalAmount` number, double
  - `guid` string, uuid
  - `amount` number, double, required — The total amount received.
  - `name` string — 
  - `date` string, date-time, required
  - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry', required
  - `methodName` string

---

[API](https://skmtc.net/practicepanther/apis/legacy-api-v1.md) · [All operations](https://skmtc.net/practicepanther/apis/legacy-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/practicepanther/legacy-api-v1/revisions/a444c5b1e78b/schema)