Actions43
- Subaccount Actions
- Customer Actions
- Refund Actions
- Installment Actions
- Invoice Actions
- Subscription Actions
- Pix Key Actions
- QR Code Static Actions
- Payment Request Actions
- Charge Actions
- Psp (Payment Service Providers) Actions
Overview
This node operation creates an invoice in the Woovi system. It is useful for automating billing processes by generating invoices with specific details such as correlation ID, description, billing date, charge or value, and customer information. Practical examples include creating invoices for customers based on charges or direct values, and specifying detailed customer data if the customer ID is not available.
Use Case Examples
- Creating an invoice with a unique correlation ID, billing date, and charge ID for an existing customer.
- Creating an invoice with a specified value and detailed customer information including tax ID, name, email, phone, and address.
Properties
| Name | Meaning |
|---|---|
| Correlation ID | Unique identifier of the invoice, required for invoice creation. |
| Description | Description of the invoice, optional for additional details. |
| Billing Date | Billing date in ISO 8601 format, required for invoice creation. |
| Charge ID | Charge ID associated with the invoice, required if Value is not provided. |
| Value | Invoice value in cents, required if Charge ID is not provided. |
| Customer ID | Existing customer ID, required if Customer object is not provided. |
| Customer | Customer object with tax ID, name, email, phone, and address, required if Customer ID is not provided. |
Output
JSON
invoiceId- The unique identifier of the created invoice.status- The status of the invoice after creation.correlationID- The correlation ID provided for the invoice.billingDate- The billing date of the invoice.value- The value of the invoice in cents.customer- The customer details associated with the invoice.
Dependencies
- Woovi API with API key credential
Troubleshooting
- Ensure that either Charge ID or Value is provided; missing both will cause an error.
- Ensure that either Customer ID or complete Customer object is provided; missing both will cause an error.
- Billing Date must be in valid ISO 8601 format; invalid format will cause request failure.
- Correlation ID must be unique to avoid conflicts or duplication errors.
Links
- Woovi API Documentation - Invoices - Official API documentation for creating and managing invoices in Woovi.