Sign in
latestSwagger 2.02026-08-1766151238.8 KB

a444c5b1e78b

Payment

Marks an existing payment as deleted, will remove all amounts applied on invoices.

delete/api/payment

Query parameters

guidstring uuid required

Response

OK

lastModifiedDatestring date-time
projectGuidstring uuid

Used to set the reference in POST and PUT

accountGuidstring uuid required

Used to set the reference in POST and PUT

authNumberstring

Authorization number for online payments

bankAccountGuidstring 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.

createdDatestring date-time
notesstring
numberinteger
currencyCodestring required

This defines the currency for this account. Must be in ISO 4217 format. Must match the currency code for the Account (contact).

amountAppliednumber double

The portion of the payment already applied towards invoices. The portion of the payment already applied towards invoices.

amountCreditednumber double

The portion of the payment not yet applied towards invoices. The portion of the payment not yet applied towards invoices.

transactionIdstring

Used to reference a transaction from an external gateway (ie. Stripe, PayPal, Auth.Net etc.)

isReconciledboolean
reconciledDatestring date-time
checkIsPrintedboolean
isDepositSlipPrintedboolean
checkNumberinteger
feeAmountInCentsnumber double
refundParentPaymentGuidstring uuid

Used to set the reference in POST and PUT

surchargeAmountnumber double
totalAmountnumber double
guidstring uuid
amountnumber double required

The total amount received.

namestring
datestring date-time required
method'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry' required
methodNamestring

Example response

{
  "saleDocumentPayments": [
    {
      "guid": "00000000-0000-0000-0000-000000000000",
      "saleDocument": {
        "guid": "00000000-0000-0000-0000-000000000000"
      },
      "payment": {
        "guid": "00000000-0000-0000-0000-000000000000"
      },
      "credit": {
        "guid": "00000000-0000-0000-0000-000000000000",
        "creditForSaleDocument": {
          "guid": "00000000-0000-0000-0000-000000000000"
        }
      }
    }
  ],
  "lastModifiedBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "projectGuid": "00000000-0000-0000-0000-000000000000",
  "accountGuid": "00000000-0000-0000-0000-000000000000",
  "bankAccountGuid": "00000000-0000-0000-0000-000000000000",
  "account": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "checkPayee": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "project": {
    "guid": "00000000-0000-0000-0000-000000000000",
    "accountGuid": "00000000-0000-0000-0000-000000000000"
  },
  "createdBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "bankAccount": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "reconciledBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "refundParentPaymentGuid": "00000000-0000-0000-0000-000000000000",
  "guid": "00000000-0000-0000-0000-000000000000"
}