Gigstack icon

Gigstack

Interact with Gigstack API for Mexican tax-compliant invoicing and payments

Actions82

Payment → Register

AI-generated

Overview

This node operation registers a payment for a client using the Gigstack API. It allows users to specify the client ID, payment line items, automation type for invoice creation, payment form, and additional optional fields such as currency, exchange rate, and metadata. It can also configure invoice series and folio for the generated invoice. This operation is useful for businesses that need to record payments and optionally generate invoices automatically upon payment registration.

Use Case Examples

  1. Register a payment for a client with multiple service items, specifying quantities and unit prices, and automatically create an invoice upon payment completion.
  2. Register a payment with a specific payment form code and custom invoice series and folio numbers.
  3. Register a payment and include additional metadata and send email notifications to the client and additional recipients.

Properties

Name Meaning
Client ID The ID of the client for this payment.
Items Payment line items including service/product ID, quantity, and optional unit price override.
Automation Type Defines what happens when the payment is completed, e.g., create an invoice automatically or no automatic invoice.
Additional Fields Optional fields such as currency, exchange rate, whether to send email, additional email addresses, and custom metadata.
Payment Form SAT payment form code indicating the payment method used.
Invoice Config Configuration for invoice series and folio number for the generated invoice.
Team ID Team ID for multi-team access. Leave empty to use default team.

Output

JSON

  • id - The unique identifier of the registered payment.
  • client
    • id - The client ID associated with the payment.
  • items - Array of payment line items with details such as service/product ID, quantity, and unit price.
  • automation_type - The automation type set for the payment (e.g., invoice creation behavior).
  • payment_form - The SAT payment form code used for the payment.
  • currency - Currency used for the payment.
  • exchange_rate - Exchange rate applied to the payment.
  • metadata - Additional custom metadata associated with the payment.
  • invoice_config
    • serie - Invoice series configured for the generated invoice.
    • folio - Invoice folio number configured for the generated invoice.

Dependencies

  • Gigstack API key credential

Troubleshooting

  • Ensure the client ID provided exists and is valid; otherwise, the API will return an error.
  • Verify that the items array contains valid service/product IDs and quantities.
  • If using custom metadata, ensure the JSON is correctly formatted to avoid parsing errors.
  • Check that the payment form code matches one of the allowed SAT codes to prevent validation errors.
  • If invoice configuration is provided, ensure the series and folio values are valid and do not conflict with existing invoices.

Links

Discussion