POST 17.0/app/accounts/createcreditnote

Description

Creates a new credit note for the specified contact and product, validating essential parameters before invoking the transaction manager to process the creation.

URI Parameters

None.

The request containing ContactId, PropertyId, BankAccountId, ProductId, Date, Amount, StatementNotes, Notes, TransferFundsFrom, TransferFundsFromBankAccountId, and PayToContact.

CreditNoteRequest
Name Description Type Additional information
ContactId

integer

None.
PropertyId

integer

None.
BankAccountId

integer

None.
ProductId

integer

None.
Date

date

None.
Amount

decimal number

None.
TaxRateId

integer

None.
StatementNotes

string

None.
Notes

string

None.
TransferFundsFrom

byte

None.
TransferFundsFromBankAccountId

integer

None.
PayToContact

boolean

None.

application/json, text/json
Sample: 
{
  "contactId": 1,
  "propertyId": 2,
  "bankAccountId": 3,
  "productId": 4,
  "date": "2025-12-12T18:53",
  "amount": 6.0,
  "taxRateId": 7,
  "statementNotes": "sample string 8",
  "notes": "sample string 9",
  "transferFundsFrom": 64,
  "transferFundsFromBankAccountId": 11,
  "payToContact": true
}

application/xml, text/xml
Sample: 
<CreditNoteRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactId>1</ContactId>
  <PropertyId>2</PropertyId>
  <BankAccountId>3</BankAccountId>
  <ProductId>4</ProductId>
  <Date>2025-12-12T18:53:59.0033576+00:00</Date>
  <Amount>6</Amount>
  <TaxRateId>7</TaxRateId>
  <StatementNotes>sample string 8</StatementNotes>
  <Notes>sample string 9</Notes>
  <TransferFundsFrom>64</TransferFundsFrom>
  <TransferFundsFromBankAccountId>11</TransferFundsFromBankAccountId>
  <PayToContact>true</PayToContact>
</CreditNoteRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

An integer result from the credit note creation operation.

integer

application/json, text/json
Sample: 
1

application/xml, text/xml
Sample: 
<int>1</int>