Actions6
Overview
This node integrates with the Upgrade.chat platform to create invoices. It allows users to generate detailed invoices for clients by specifying contact information, invoice details, billing and shipping addresses, line items, transactions, and totals. This is useful in scenarios where businesses want to automate invoice creation within their workflows, such as after a sale or service completion.
Practical examples include:
- Automatically creating an invoice when a new order is placed.
- Generating invoices for recurring billing cycles.
- Creating invoices with detailed line items and transaction records for accounting purposes.
Properties
| Name | Meaning |
|---|---|
| Contact ID | Sperse Contact ID used to identify the client for the invoice. |
| External Contact ID | External reference ID for the contact, alternative to Contact ID. |
| Status | Invoice status; options: Draft, Final, Paid, Sent. |
| Invoice Number | Unique number identifying the invoice. |
| Date of the Invoice | The date when the invoice was issued (ISO 8601 format, e.g., 2024-06-11T11:11:41Z). |
| Due Date of Invoice | The due date for payment of the invoice (ISO 8601 format). |
| Currency ID | Currency code for the invoice amount; options include AUD, CAD, CHF, CNY, EUR, GBP, IND, JPY, NZD, SEK, USD. |
| Grand Total | Total amount of the invoice including all charges. Default 0 if not specified. |
| Totals | Collection of totals including Discount Total, Shipping Total, and Tax Total. |
| Billing Address | Collection of billing address fields such as company, first/last name, phone, email, country, state, city, zip, and address lines. |
| Shipping Address | Collection of shipping address fields similar to billing address. |
| Invoice Description | Description text for the invoice. |
| Invoice Note | Additional notes related to the invoice. |
| Quantity | Quantity of the item being invoiced. |
| Rate | Rate per unit for the item. |
| Unit ID | Unit type for the quantity; options include Custom, Day, Feet, Hour, Kilogram, Month, Package, Piece, Pound, Unit, Zone. |
| Total Item Price | Total price for the item line (quantity × rate). Default 0 if not specified. |
| Sort Order | Numeric value to sort invoice lines; default 0. |
| Description | Description of the individual invoice line item. |
| Additional Line Field | Collection including Commissionable Amount and Product Code (used to look up product). |
| Transaction Date | Date of the transaction related to the invoice (ISO 8601 format). |
| Amount | Amount of the transaction. |
| Historical Data | Flag indicating if this is historical data (true) or an actual transaction (false). Default true. |
| Additional Transaction Field | Collection including Transaction Description, Gateway Name, and Gateway Transaction ID. |
Output
The node outputs JSON data representing the created invoice as returned by the Upgrade.chat API. This includes all invoice details submitted, such as contact info, invoice metadata, line items, transactions, and totals.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Upgrade.chat API.
- The node makes HTTP POST requests to Upgrade.chat endpoints to create invoices.
- No additional external dependencies are required beyond the configured API authentication.
Troubleshooting
Common issues:
- Missing required fields such as Contact ID, Invoice Number, or dates may cause errors.
- Incorrect date formats (not ISO 8601) can lead to API rejection.
- Invalid currency codes or unsupported unit types may cause failures.
- Network or authentication errors if the API key is invalid or missing.
Error messages:
- Errors from the API will typically indicate which field is invalid or missing.
- Authentication errors suggest checking the API key credential configuration.
- Validation errors on amounts or totals require verifying numeric inputs.
Resolution tips:
- Ensure all required properties are provided and correctly formatted.
- Use ISO 8601 format for all date/time fields.
- Verify that the API key credential is properly set up and has necessary permissions.
- Check the Upgrade.chat API documentation for valid values and constraints.