lago-javascript-client 1.10.0 → 1.11.0

package/esm/openapi/client.d.ts

@@ -1437,10 +1437,10 @@ export interface IntegrationCustomer {
     lago_id?: string;
     /**
      * The integration type used for accounting and tax syncs.
-     * Accepted values: `netsuite`.
+     * Accepted values: `netsuite, anrok`.
      * @example "netsuite"
      */
-    type?: "netsuite";
+    type?: "netsuite" | "anrok";
     /**
      * Unique code used to identify an integration connection.
      * @example "netsuite-eu-1"
@@ -1670,6 +1670,14 @@ export interface CustomerCreateInput {
          * @example 30
          */
         net_payment_term?: number | null;
+        /**
+         * Specifies how invoices with a zero total amount should be handled:
+         * - `inherit`: (Default) Follows the organization-level configuration.
+         * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+         * - `skip`: Invoices with a total amount of zero are not finalized.
+         * @example "inherit"
+         */
+        finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
         /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
         billing_configuration?: CustomerBillingConfiguration;
         /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
@@ -1683,10 +1691,10 @@ export interface CustomerCreateInput {
             id?: string;
             /**
              * The integration type used for accounting and tax syncs.
-             * Accepted values: `netsuite`.
+             * Accepted values: `netsuite, anrok, xero`.
              * @example "netsuite"
              */
-            integration_type?: "netsuite";
+            integration_type?: "netsuite" | "anrok" | "xero";
             /**
              * Unique code used to identify an integration connection.
              * @example "netsuite-eu-1"
@@ -1764,7 +1772,7 @@ export interface CustomerMetadata {
      */
     created_at: string;
 }
-export interface CustomerObject {
+export type CustomerObject = {
     /**
      * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
      * @format uuid
@@ -1877,13 +1885,22 @@ export interface CustomerObject {
      * @example "2022-04-29T08:59:51Z"
      */
     updated_at?: string;
+    /**
+     * Specifies how invoices with a zero total amount should be handled:
+     * - `inherit`: (Default) Follows the organization-level configuration.
+     * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+     * - `skip`: Invoices with a total amount of zero are not finalized.
+     * @example "inherit"
+     */
+    finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
     billing_configuration?: CustomerBillingConfiguration;
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
     shipping_address?: Address;
-    integration_customers?: IntegrationCustomer[];
     metadata?: CustomerMetadata[];
-}
+} & {
+    integration_customers?: IntegrationCustomer[];
+};
 export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
@@ -2128,6 +2145,16 @@ export interface FeeObject {
      * @example 100
      */
     amount_cents: number;
+    /**
+     * The cost of this specific fee, excluding any applicable taxes, with precision.
+     * @example "1.0001"
+     */
+    precise_amount?: string;
+    /**
+     * The cost of this specific fee, including any applicable taxes, with precision.
+     * @example "1.0212"
+     */
+    precise_total_amount?: string;
     /** The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed. */
     amount_currency: Currency;
     /**
@@ -2135,6 +2162,11 @@ export interface FeeObject {
      * @example 20
      */
     taxes_amount_cents: number;
+    /**
+     * The cost of the tax associated with this specific fee, with precision.
+     * @example "0.20123"
+     */
+    taxes_precise_amount?: string;
     /**
      * The tax rate associated with this specific fee.
      * @example 20
@@ -2639,7 +2671,7 @@ export interface InvoiceMetadataObject {
      */
     created_at?: string;
 }
-export interface InvoiceObject {
+export type InvoiceObject = {
     /**
      * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
      * @format uuid
@@ -2769,12 +2801,13 @@ export interface InvoiceObject {
      * @example "https://getlago.com/invoice/file"
      */
     file_url?: string;
+} & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
     applied_usage_thresholds?: AppliedUsageThresholdObject[] | null;
-}
+};
 export type InvoiceObjectExtended = InvoiceObject & {
     credits?: CreditObject[];
     fees?: FeeObject[];
@@ -2998,6 +3031,11 @@ export interface OrganizationObject {
     billing_configuration: OrganizationBillingConfiguration;
     /** List of default organization taxes */
     taxes?: TaxObject[];
+    /**
+     * Indicates whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
+     * @example false
+     */
+    finalize_zero_amount_invoice?: boolean;
 }
 export interface OrganizationUpdateInput {
     organization: {
@@ -3085,6 +3123,11 @@ export interface OrganizationUpdateInput {
         email_settings?: ("invoice.finalized" | "credit_note.created")[];
         /** The custom billing settings for your organization. */
         billing_configuration?: OrganizationBillingConfiguration;
+        /**
+         * Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
+         * @example false
+         */
+        finalize_zero_amount_invoice?: boolean;
     };
 }
 export interface OverdueBalanceObject {
@@ -4544,7 +4587,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.10.0
+ * @version 1.11.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5534,6 +5577,102 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         updateOrganization: (data: OrganizationUpdateInput, params?: RequestParams) => Promise<HttpResponse<Organization, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
     };
+    paymentRequests: {
+        /**
+         * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
+         *
+         * @tags payment_requests
+         * @name CreatePaymentRequest
+         * @summary Create a payment request
+         * @request POST:/payment_requests
+         * @secure
+         */
+        createPaymentRequest: (data: {
+            payment_request: {
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                customer_external_id?: string;
+                /**
+                 * The customer's email address used for sending dunning notifications
+                 * @format email
+                 * @example "dinesh@piedpiper.test"
+                 */
+                email: string;
+                /** A list of Lago IDs for the customer's overdue invoices to start the dunning process */
+                lago_invoice_ids: string[];
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment_request: {
+                /**
+                 * Unique identifier of the payment request, created by Lago.
+                 * @format uuid
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_id: string;
+                /**
+                 * The customer's email address used for sending dunning notifications
+                 * @format email
+                 * @example "dinesh@piedpiper.test"
+                 */
+                email: string;
+                /**
+                 * The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
+                 * @example 100
+                 */
+                amount_cents: number;
+                /** The currency of the payment request. */
+                amount_currency: Currency;
+                /**
+                 * The status of the payment associated with the payment request. It can have one of the following values:
+                 * - `pending`: the payment is pending, waiting for payment processing in the payment provider or when the invoice is emitted but users have not updated the payment status through the endpoint.
+                 * - `succeeded`: the payment of the payment request has been successfully processed.
+                 * - `failed`: the payment of the payment request has failed or encountered an error during processing.
+                 * @example "succeeded"
+                 */
+                payment_status: "pending" | "succeeded" | "failed";
+                /**
+                 * The date and time when the payment request was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the payment request was initially created.
+                 * @format date-time
+                 * @example "2022-04-29T08:59:51Z"
+                 */
+                created_at: string;
+                /** The customer on which the payment request applies. It refers to the customer account or entity associated with the payment request. */
+                customer: any;
+                invoices: any[];
+            };
+        }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to list all existing payment requests.
+         *
+         * @tags payment_requests
+         * @name FindAllPaymentRequests
+         * @summary List all payment requests
+         * @request GET:/payment_requests
+         * @secure
+         */
+        findAllPaymentRequests: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Unique identifier assigned to the customer in your application.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment_requests: any[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
+    };
     plans: {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.10.0
+ * @version 1.11.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -1172,6 +1172,43 @@ export class Api extends HttpClient {
             ...params,
         }),
     };
+    paymentRequests = {
+        /**
+         * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
+         *
+         * @tags payment_requests
+         * @name CreatePaymentRequest
+         * @summary Create a payment request
+         * @request POST:/payment_requests
+         * @secure
+         */
+        createPaymentRequest: (data, params = {}) => this.request({
+            path: `/payment_requests`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list all existing payment requests.
+         *
+         * @tags payment_requests
+         * @name FindAllPaymentRequests
+         * @summary List all payment requests
+         * @request GET:/payment_requests
+         * @secure
+         */
+        findAllPaymentRequests: (query, params = {}) => this.request({
+            path: `/payment_requests`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     plans = {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "name": "lago-javascript-client",
   "sideEffects": false,
-  "version": "v1.10.0",
+  "version": "v1.11.0",
   "description": "Lago JavaScript API Client",
   "repository": {
     "type": "git",

package/script/openapi/client.d.ts

@@ -1437,10 +1437,10 @@ export interface IntegrationCustomer {
     lago_id?: string;
     /**
      * The integration type used for accounting and tax syncs.
-     * Accepted values: `netsuite`.
+     * Accepted values: `netsuite, anrok`.
      * @example "netsuite"
      */
-    type?: "netsuite";
+    type?: "netsuite" | "anrok";
     /**
      * Unique code used to identify an integration connection.
      * @example "netsuite-eu-1"
@@ -1670,6 +1670,14 @@ export interface CustomerCreateInput {
          * @example 30
          */
         net_payment_term?: number | null;
+        /**
+         * Specifies how invoices with a zero total amount should be handled:
+         * - `inherit`: (Default) Follows the organization-level configuration.
+         * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+         * - `skip`: Invoices with a total amount of zero are not finalized.
+         * @example "inherit"
+         */
+        finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
         /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
         billing_configuration?: CustomerBillingConfiguration;
         /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
@@ -1683,10 +1691,10 @@ export interface CustomerCreateInput {
             id?: string;
             /**
              * The integration type used for accounting and tax syncs.
-             * Accepted values: `netsuite`.
+             * Accepted values: `netsuite, anrok, xero`.
              * @example "netsuite"
              */
-            integration_type?: "netsuite";
+            integration_type?: "netsuite" | "anrok" | "xero";
             /**
              * Unique code used to identify an integration connection.
              * @example "netsuite-eu-1"
@@ -1764,7 +1772,7 @@ export interface CustomerMetadata {
      */
     created_at: string;
 }
-export interface CustomerObject {
+export type CustomerObject = {
     /**
      * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
      * @format uuid
@@ -1877,13 +1885,22 @@ export interface CustomerObject {
      * @example "2022-04-29T08:59:51Z"
      */
     updated_at?: string;
+    /**
+     * Specifies how invoices with a zero total amount should be handled:
+     * - `inherit`: (Default) Follows the organization-level configuration.
+     * - `finalize`: Invoices are issued and finalized even if the total amount is zero.
+     * - `skip`: Invoices with a total amount of zero are not finalized.
+     * @example "inherit"
+     */
+    finalize_zero_amount_invoice?: "inherit" | "skip" | "finalize";
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
     billing_configuration?: CustomerBillingConfiguration;
     /** Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer. */
     shipping_address?: Address;
-    integration_customers?: IntegrationCustomer[];
     metadata?: CustomerMetadata[];
-}
+} & {
+    integration_customers?: IntegrationCustomer[];
+};
 export type CustomerObjectExtended = CustomerObject & {
     metadata?: CustomerMetadata[];
     /** List of customer taxes */
@@ -2128,6 +2145,16 @@ export interface FeeObject {
      * @example 100
      */
     amount_cents: number;
+    /**
+     * The cost of this specific fee, excluding any applicable taxes, with precision.
+     * @example "1.0001"
+     */
+    precise_amount?: string;
+    /**
+     * The cost of this specific fee, including any applicable taxes, with precision.
+     * @example "1.0212"
+     */
+    precise_total_amount?: string;
     /** The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed. */
     amount_currency: Currency;
     /**
@@ -2135,6 +2162,11 @@ export interface FeeObject {
      * @example 20
      */
     taxes_amount_cents: number;
+    /**
+     * The cost of the tax associated with this specific fee, with precision.
+     * @example "0.20123"
+     */
+    taxes_precise_amount?: string;
     /**
      * The tax rate associated with this specific fee.
      * @example 20
@@ -2639,7 +2671,7 @@ export interface InvoiceMetadataObject {
      */
     created_at?: string;
 }
-export interface InvoiceObject {
+export type InvoiceObject = {
     /**
      * Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
      * @format uuid
@@ -2769,12 +2801,13 @@ export interface InvoiceObject {
      * @example "https://getlago.com/invoice/file"
      */
     file_url?: string;
+} & {
     /** The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. */
     customer?: CustomerObject;
     metadata?: InvoiceMetadataObject[];
     applied_taxes?: InvoiceAppliedTaxObject[];
     applied_usage_thresholds?: AppliedUsageThresholdObject[] | null;
-}
+};
 export type InvoiceObjectExtended = InvoiceObject & {
     credits?: CreditObject[];
     fees?: FeeObject[];
@@ -2998,6 +3031,11 @@ export interface OrganizationObject {
     billing_configuration: OrganizationBillingConfiguration;
     /** List of default organization taxes */
     taxes?: TaxObject[];
+    /**
+     * Indicates whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
+     * @example false
+     */
+    finalize_zero_amount_invoice?: boolean;
 }
 export interface OrganizationUpdateInput {
     organization: {
@@ -3085,6 +3123,11 @@ export interface OrganizationUpdateInput {
         email_settings?: ("invoice.finalized" | "credit_note.created")[];
         /** The custom billing settings for your organization. */
         billing_configuration?: OrganizationBillingConfiguration;
+        /**
+         * Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
+         * @example false
+         */
+        finalize_zero_amount_invoice?: boolean;
     };
 }
 export interface OverdueBalanceObject {
@@ -4544,7 +4587,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 1.10.0
+ * @version 1.11.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -5534,6 +5577,102 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         updateOrganization: (data: OrganizationUpdateInput, params?: RequestParams) => Promise<HttpResponse<Organization, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
     };
+    paymentRequests: {
+        /**
+         * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
+         *
+         * @tags payment_requests
+         * @name CreatePaymentRequest
+         * @summary Create a payment request
+         * @request POST:/payment_requests
+         * @secure
+         */
+        createPaymentRequest: (data: {
+            payment_request: {
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                customer_external_id?: string;
+                /**
+                 * The customer's email address used for sending dunning notifications
+                 * @format email
+                 * @example "dinesh@piedpiper.test"
+                 */
+                email: string;
+                /** A list of Lago IDs for the customer's overdue invoices to start the dunning process */
+                lago_invoice_ids: string[];
+            };
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment_request: {
+                /**
+                 * Unique identifier of the payment request, created by Lago.
+                 * @format uuid
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_id: string;
+                /**
+                 * The customer's email address used for sending dunning notifications
+                 * @format email
+                 * @example "dinesh@piedpiper.test"
+                 */
+                email: string;
+                /**
+                 * The sum of the total amounts of all the invoices included in the payment request, expressed in cents.
+                 * @example 100
+                 */
+                amount_cents: number;
+                /** The currency of the payment request. */
+                amount_currency: Currency;
+                /**
+                 * The status of the payment associated with the payment request. It can have one of the following values:
+                 * - `pending`: the payment is pending, waiting for payment processing in the payment provider or when the invoice is emitted but users have not updated the payment status through the endpoint.
+                 * - `succeeded`: the payment of the payment request has been successfully processed.
+                 * - `failed`: the payment of the payment request has failed or encountered an error during processing.
+                 * @example "succeeded"
+                 */
+                payment_status: "pending" | "succeeded" | "failed";
+                /**
+                 * The date and time when the payment request was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the payment request was initially created.
+                 * @format date-time
+                 * @example "2022-04-29T08:59:51Z"
+                 */
+                created_at: string;
+                /** The customer on which the payment request applies. It refers to the customer account or entity associated with the payment request. */
+                customer: any;
+                invoices: any[];
+            };
+        }, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
+        /**
+         * @description This endpoint is used to list all existing payment requests.
+         *
+         * @tags payment_requests
+         * @name FindAllPaymentRequests
+         * @summary List all payment requests
+         * @request GET:/payment_requests
+         * @secure
+         */
+        findAllPaymentRequests: (query?: {
+            /**
+             * Page number.
+             * @example 1
+             */
+            page?: number;
+            /**
+             * Number of records per page.
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Unique identifier assigned to the customer in your application.
+             * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+             */
+            external_customer_id?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<{
+            payment_requests: any[];
+            meta: PaginationMeta;
+        }, ApiErrorUnauthorized>>;
+    };
     plans: {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.10.0
+ * @version 1.11.0
  * @license AGPLv3
  * @baseUrl https://{region}.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -1176,6 +1176,43 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    paymentRequests = {
+        /**
+         * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
+         *
+         * @tags payment_requests
+         * @name CreatePaymentRequest
+         * @summary Create a payment request
+         * @request POST:/payment_requests
+         * @secure
+         */
+        createPaymentRequest: (data, params = {}) => this.request({
+            path: `/payment_requests`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list all existing payment requests.
+         *
+         * @tags payment_requests
+         * @name FindAllPaymentRequests
+         * @summary List all payment requests
+         * @request GET:/payment_requests
+         * @secure
+         */
+        findAllPaymentRequests: (query, params = {}) => this.request({
+            path: `/payment_requests`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     plans = {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.