ChargeKeep icon

ChargeKeep

Easy-to-use recurring and one-time payments software for Stripe & PayPal

Actions6

Overview

This node allows you to create invoices in the ChargeKeep system, a recurring and one-time payments software that integrates with Stripe and PayPal. It is useful for automating invoice creation workflows, such as billing clients, recording transactions, and managing invoice details programmatically.

Typical use cases include:

  • Generating invoices for customers after a sale or service.
  • Automating billing cycles by creating draft or final invoices.
  • Recording payment transactions linked to invoices.
  • Managing detailed invoice line items and addresses.

For example, you can create an invoice for a client with specific billing and shipping addresses, set the invoice status (Draft, Final, Paid, Sent), specify currency and totals, add line items with quantities and rates, and attach transaction details like payment gateway info.

Properties

Name Meaning
Contact ID Sperse Contact ID used to identify the client for whom the invoice is created.
External Contact ID External reference ID for the contact, used alternatively to look up the client.
Status Invoice status; options are: Draft, Final, Paid, Sent.
Invoice Number Unique number identifying the invoice.
Date of the Invoice The date when the invoice was issued, formatted as ISO 8601 string (e.g., 2024-06-11T11:11:41Z).
Due Date of the Invoice The due date for payment of the invoice, formatted as ISO 8601 string.
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 is 0 if no data is passed.
Totals Collection of totals including Discount Total, Shipping Total, and Tax Total.
Billing Address Collection of billing address fields such as company, first name, last name, phone, email, country/state IDs and names, city, zip, and address lines 1 & 2.
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 in the invoice line.
Rate Rate per unit for the invoice line 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 invoice line item. Default is 0 if no data is passed.
Sort Order Numeric value to define the order of the line item in the invoice. Default is 0 if no data is passed.
Additional Line Field Collection of additional line item fields including Commissionable Amount, Product Code (used to look up product), and Description.
Transaction Date Date of the transaction related to the invoice, formatted as ISO 8601 string.
Amount Amount of the transaction.
Historical Data Boolean option indicating if this is historical data (not an actual transaction). Options: true or false (default false).
Additional Transaction Field Collection of additional transaction fields including Transaction Description, Gateway Name, and Gateway Transaction ID.

Output

The node outputs JSON data representing the response from the ChargeKeep API after creating the invoice. This typically includes details of the newly created invoice such as its ID, status, amounts, dates, and any other metadata returned by the API.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the ChargeKeep API.
  • The node uses the ChargeKeep REST API endpoints to create invoices.
  • Proper configuration of the API authentication credential in n8n is necessary.
  • Dates must be provided in ISO 8601 format (e.g., YYYY-MM-DDTHH:mm:ssZ).

Troubleshooting

  • Invalid or missing required fields: Ensure all required properties such as Contact ID, Status, Invoice Number, Dates, Currency, Quantity, Rate, and Amounts are correctly provided.
  • Date format errors: Dates must be in ISO 8601 format; otherwise, the API may reject the request.
  • Authentication failures: Verify that the API key credential is valid and has sufficient permissions.
  • API errors: If the API returns errors, check the error message for details. Common issues include invalid contact references or currency codes.
  • Continue on Fail: The node supports continuing execution even if some items fail, which can help in batch processing scenarios.

Links and References

Discussion