Standalone Credit Memo Input
Input representation of the details required to create a standalone credit memo.
This example shows a sample request with the Ignore tax strategy.
This example shows a sample request with the ManualOverride tax strategy.
This example shows a sample request with the Calculate tax strategy for a charge line.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
billToContactId | String | Contact related to the credit memo. | Optional | 62.0 |
billingAccountId | String | ID of the account that the credit is issued to. | 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 | ISO code currency of the new credit that’s issued. | Optional | 62.0 |
customFields | Map | Custom field values on the credit memo record, as key-value pairs. | Optional | 68.0 |
description | String | Description for the new credit that’s issued. | 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 | ID of the external reference for the credit memo. | Optional | 62.0 |
externalReferenceDataSource | String | Source of the external reference for the credit memo. | 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. | Required | 62.0 |
type | String | Optional | 62.0 |
Valid values are:
Ignore—Specifies that the creation of tax lines must be ignored.Manual Override—Specifies that the provided tax values must be considered for taxes.Calculate—Specifies that tax must be calculated by using the API.