avanta icon

avanta

Consume avanta API

Actions57

Servicecenter - Credit Memo → Create or Update

AI-generated

Overview

This node handles the creation or updating of credit memos within the Servicecenter resource of the Avanta API. It is useful for automating credit memo management processes such as issuing refunds or adjustments to customer accounts. Practical examples include creating new credit memos with detailed item positions, attaching document files, and updating existing credit memos with additional fields or status changes.

Use Case Examples

  1. Creating a credit memo for a customer with multiple item positions and custom fields.
  2. Updating an existing credit memo with new document files and status information.

Properties

Name Meaning
Request Options Options to configure the API request such as enabling debug mode, ignoring SSL issues, and setting request timeout.
Return to Webhook Whether to return the response to a webhook (requires a Respond to Webhook node).
Use Bulk API Whether to use the bulk API for processing multiple items.
Dataflow ID Optional override for the dataflow ID, automatically read from webhook input if not set.
Customer ID ID of the customer for whom the credit memo is created.
Company ID ID of the company associated with the credit memo.
Billing Company Name of the billing company.
Billing Name Name of the billing contact.
Customer Creditmemo ID Credit memo ID provided by the customer.
Status Status of the credit memo.
Creditmemo Positions Type Method to add credit memo positions, either via UI fields or raw JSON.
Creditmemo Positions Collection of credit memo item positions with detailed fields such as item name, price, quantity, SKU, and additional custom fields.
Creditmemo Positions JSON Raw JSON input for credit memo positions when using JSON input mode.
Document Files Credit memo document files, either added manually or via JSON array.
Additional Fields Additional optional fields for the credit memo such as dates, custom fields, customer order ID, extension attributes, grand total, tax amount, and billing address details.

Output

JSON

  • creditmemo_id - Internal credit memo ID assigned by the system.
  • status - Status of the credit memo after creation or update.
  • customer_id - ID of the customer associated with the credit memo.
  • company_id - ID of the company associated with the credit memo.
  • billing_company - Name of the billing company.
  • billing_name - Name of the billing contact.
  • creditmemo_positions - Array of credit memo item positions with details such as name, price, quantity, SKU, and additional fields.
  • document_files - Array of document files attached to the credit memo.
  • additional_fields - Additional optional fields and custom attributes related to the credit memo.

Dependencies

  • Avanta API key credential

Troubleshooting

  • Ensure all required fields such as Customer ID, Company ID, Billing Company, Billing Name, and Customer Creditmemo ID are provided to avoid validation errors.
  • If using JSON input for credit memo positions or document files, ensure the JSON is correctly formatted to prevent parsing errors.
  • Enable Debug Mode in Request Options to get detailed API request information for troubleshooting connectivity or data issues.
  • If SSL certificate validation fails, use the Ignore SSL Issues option cautiously to bypass SSL errors, but be aware of security risks.

Links

Discussion