Standalone Credit Memo Input
Input representation of the details required to create a standalone credit
memo.
- JSON example
- This example shows a sample request with the Ignore tax
strategy.
{ "billingAccountId": "001j000000WCFB800x", "type": "Posted", "description": "Standalone credit memo with ignored tax.", "currencyIsoCode": "USD", "taxStrategy": "Ignore", "charges": [ { "chargeAmount": 100, "productId": "01tR0000000njDiIAI" } ] }
- This example shows a sample request with the Calculate tax strategy for a charge
line.
{ "billingAccountId": "001DU000001nhoPYAQ", "description": "Standalone Credit Memo", "type": "Posted", "currencyIsoCode": "USD", "taxStrategy": "Ignore", "charges": [ { "productId": "01tR0000000njDiIAI", "chargeAmount": 10, "taxStrategy": "Calculate", "treatmentId": "1ttxx00000001VZAAY" } ] }
- Properties
-
Name Type Description Required or Optional Available Version billToContactId String Optional 62.0 billingAccountId String Required 62.0 charges Standalone Credit Memo Charge Input[] Charge lines of the credit memo. Requires at least one charge line.
Required 62.0 currencyIsoCode String Optional 62.0 description String Optional 62.0 effectiveDate String Effective date of the credit memo. If the value isn’t specified, then it’s null.
Optional 62.0 externalReference String Optional 62.0 externalReferenceDataSource String Optional 62.0 taxEffectiveDate String Effective date of the credit memo tax. If the value isn’t specified, then it’s null.
Optional 62.0 taxStrategy String Specifies how tax lines must be created for the standalone credit memos. Valid values are:
- Ignore—Specifies that the creation of tax lines must be ignored.
- Calculate—Specifies that tax must be calculated by using the API.
Required 62.0 type String Type of credit memo to be created. Valid value is Posted.
Optional 62.0