@pronesoft-rd/ecf-sdk 0.0.1

package/docs/Subtotal.md

@@ -0,0 +1,61 @@
+
+# Subtotal
+
+Subtotal for a page or section within a multi-page document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`number` | number
+`amount` | number
+`description` | string
+`taxableAmount` | number
+`taxableAmount1` | number
+`taxableAmount2` | number
+`taxableAmount3` | number
+`totalITBIS` | number
+`itbis1` | number
+`itbis2` | number
+`itbis3` | number
+`additionalTaxes` | number
+`exemptAmount` | number
+`lines` | number
+
+## Example
+
+```typescript
+import type { Subtotal } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "number": null,
+  "amount": null,
+  "description": null,
+  "taxableAmount": null,
+  "taxableAmount1": null,
+  "taxableAmount2": null,
+  "taxableAmount3": null,
+  "totalITBIS": null,
+  "itbis1": null,
+  "itbis2": null,
+  "itbis3": null,
+  "additionalTaxes": null,
+  "exemptAmount": null,
+  "lines": null,
+} satisfies Subtotal
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Subtotal
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TaxSequence.md

@@ -0,0 +1,39 @@
+
+# TaxSequence
+
+A registered fiscal number sequence for a given invoice type.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | [InvoiceType](InvoiceType.md)
+`nextNumber` | string
+
+## Example
+
+```typescript
+import type { TaxSequence } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "nextNumber": E310000000001,
+} satisfies TaxSequence
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TaxSequence
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TaxSequencesApi.md

@@ -0,0 +1,246 @@
+# TaxSequencesApi
+
+All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createTaxSequence**](TaxSequencesApi.md#createtaxsequenceoperation) | **POST** /tax-sequences | Create new tax sequence |
+| [**getNextNumber**](TaxSequencesApi.md#getnextnumber) | **GET** /tax-sequences/next | Get next available fiscal number |
+| [**listTaxSequences**](TaxSequencesApi.md#listtaxsequences) | **GET** /tax-sequences | List tax sequences |
+
+
+
+## createTaxSequence
+
+> createTaxSequence(xTenantId, createTaxSequenceRequest)
+
+Create new tax sequence
+
+Registers a new block of fiscal numbers for a given invoice type. The `from` and `to` values define the numeric range of the sequence. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TaxSequencesApi,
+} from '@pronesoft/ecf-sdk';
+import type { CreateTaxSequenceOperationRequest } from '@pronesoft/ecf-sdk';
+
+async function example() {
+  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TaxSequencesApi(config);
+
+  const body = {
+    // string | UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup. 
+    xTenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CreateTaxSequenceRequest
+    createTaxSequenceRequest: {"type":"31","from":1,"to":500},
+  } satisfies CreateTaxSequenceOperationRequest;
+
+  try {
+    const data = await api.createTaxSequence(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xTenantId** | `string` | UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.  | [Defaults to `undefined`] |
+| **createTaxSequenceRequest** | [CreateTaxSequenceRequest](CreateTaxSequenceRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Sequence created successfully |  -  |
+| **400** | Validation error (400 Bad Request). The request body or parameters did not pass validation. Check the `message` field for details.  |  -  |
+| **401** | Authorization error. The token is missing, expired, or invalid. Call `POST /oauth/token` to get a new token.  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getNextNumber
+
+> GetNextNumber200Response getNextNumber(xTenantId, type, environment)
+
+Get next available fiscal number
+
+Returns the next available e-NCF number for a given invoice type and environment. Use this number as the `invoiceNumber` when submitting a document. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TaxSequencesApi,
+} from '@pronesoft/ecf-sdk';
+import type { GetNextNumberRequest } from '@pronesoft/ecf-sdk';
+
+async function example() {
+  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TaxSequencesApi(config);
+
+  const body = {
+    // string | UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup. 
+    xTenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // InvoiceType | Invoice type code (e.g. \"31\" for Tax Credit Invoice).
+    type: ...,
+    // Environment | Target environment for the sequence.
+    environment: ...,
+  } satisfies GetNextNumberRequest;
+
+  try {
+    const data = await api.getNextNumber(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xTenantId** | `string` | UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.  | [Defaults to `undefined`] |
+| **type** | `InvoiceType` | Invoice type code (e.g. \"31\" for Tax Credit Invoice). | [Defaults to `undefined`] [Enum: 31, 32, 33, 34, 41, 43, 44, 45, 46, 47] |
+| **environment** | `Environment` | Target environment for the sequence. | [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
+
+### Return type
+
+[**GetNextNumber200Response**](GetNextNumber200Response.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Next available e-NCF number |  -  |
+| **401** | Authorization error. The token is missing, expired, or invalid. Call `POST /oauth/token` to get a new token.  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listTaxSequences
+
+> ListTaxSequences200Response listTaxSequences(xTenantId, type)
+
+List tax sequences
+
+Returns all fiscal number sequences registered for the tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TaxSequencesApi,
+} from '@pronesoft/ecf-sdk';
+import type { ListTaxSequencesRequest } from '@pronesoft/ecf-sdk';
+
+async function example() {
+  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TaxSequencesApi(config);
+
+  const body = {
+    // string | UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup. 
+    xTenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // InvoiceType | Filter by invoice type (e.g. \"31\" for Tax Credit). (optional)
+    type: ...,
+  } satisfies ListTaxSequencesRequest;
+
+  try {
+    const data = await api.listTaxSequences(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xTenantId** | `string` | UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.  | [Defaults to `undefined`] |
+| **type** | `InvoiceType` | Filter by invoice type (e.g. \"31\" for Tax Credit). | [Optional] [Defaults to `undefined`] [Enum: 31, 32, 33, 34, 41, 43, 44, 45, 46, 47] |
+
+### Return type
+
+[**ListTaxSequences200Response**](ListTaxSequences200Response.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of tax sequences |  -  |
+| **401** | Authorization error. The token is missing, expired, or invalid. Call `POST /oauth/token` to get a new token.  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/Totals.md

@@ -0,0 +1,81 @@
+
+# Totals
+
+Document totals. `totalAmount` is required. Provide ITBIS breakdowns by rate when applicable. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`taxableAmount` | number
+`taxableAmount1` | number
+`taxableAmount2` | number
+`taxableAmount3` | number
+`exemptAmount` | number
+`itbisRate1` | number
+`itbisRate2` | number
+`itbisRate3` | number
+`totalITBIS` | number
+`itbis1` | number
+`itbis2` | number
+`itbis3` | number
+`additionalTaxAmount` | number
+`additionalTaxes` | [Array<ItemAdditionalTax>](ItemAdditionalTax.md)
+`totalAmount` | number
+`nonBillableAmount` | number
+`periodAmount` | number
+`previousBalance` | number
+`advancePaymentAmount` | number
+`amountToPay` | number
+`totalWithheldITBIS` | number
+`totalIncomeTaxWithholding` | number
+`totalITBISPerception` | number
+`totalISRPerception` | number
+
+## Example
+
+```typescript
+import type { Totals } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "taxableAmount": null,
+  "taxableAmount1": null,
+  "taxableAmount2": null,
+  "taxableAmount3": null,
+  "exemptAmount": null,
+  "itbisRate1": 0.18,
+  "itbisRate2": 0.16,
+  "itbisRate3": 0.0,
+  "totalITBIS": null,
+  "itbis1": null,
+  "itbis2": null,
+  "itbis3": null,
+  "additionalTaxAmount": null,
+  "additionalTaxes": null,
+  "totalAmount": 11800.0,
+  "nonBillableAmount": null,
+  "periodAmount": null,
+  "previousBalance": null,
+  "advancePaymentAmount": null,
+  "amountToPay": null,
+  "totalWithheldITBIS": null,
+  "totalIncomeTaxWithholding": null,
+  "totalITBISPerception": null,
+  "totalISRPerception": null,
+} satisfies Totals
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Totals
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Transport.md

@@ -0,0 +1,45 @@
+
+# Transport
+
+Transport/delivery information (required for certain invoice types).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`driver` | string
+`vehicleId` | string
+`licensePlate` | string
+`route` | string
+`departureDate` | Date
+`arrivalDate` | Date
+
+## Example
+
+```typescript
+import type { Transport } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "driver": null,
+  "vehicleId": null,
+  "licensePlate": null,
+  "route": null,
+  "departureDate": null,
+  "arrivalDate": null,
+} satisfies Transport
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Transport
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UploadCertificate201Response.md

@@ -0,0 +1,38 @@
+
+# UploadCertificate201Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`representative` | string
+`expirationDate` | Date
+
+## Example
+
+```typescript
+import type { UploadCertificate201Response } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "representative": null,
+  "expirationDate": null,
+} satisfies UploadCertificate201Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UploadCertificate201Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UploadCertificateResponse.md

@@ -0,0 +1,39 @@
+
+# UploadCertificateResponse
+
+Response after successfully uploading a digital certificate.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`representative` | string
+`expirationDate` | Date
+
+## Example
+
+```typescript
+import type { UploadCertificateResponse } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Certificate uploaded successfully,
+  "representative": null,
+  "expirationDate": null,
+} satisfies UploadCertificateResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UploadCertificateResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebhookConfigResponse.md

@@ -0,0 +1,45 @@
+
+# WebhookConfigResponse
+
+A registered webhook configuration.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`url` | string
+`eventTypes` | [Array<WebhookEventType>](WebhookEventType.md)
+`isActive` | boolean
+`createdAt` | Date
+`lastTriggeredAt` | Date
+
+## Example
+
+```typescript
+import type { WebhookConfigResponse } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "url": null,
+  "eventTypes": null,
+  "isActive": null,
+  "createdAt": null,
+  "lastTriggeredAt": null,
+} satisfies WebhookConfigResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebhookConfigResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+