@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.2

package/docs/EcfStatsResponse.md

@@ -0,0 +1,50 @@
+
+# EcfStatsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`accepted` | number
+`rejected` | number
+`processing` | number
+`error` | number
+`successRate` | string
+`period` | string
+`dateFrom` | Date
+`dateTo` | Date
+
+## Example
+
+```typescript
+import type { EcfStatsResponse } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "accepted": null,
+  "rejected": null,
+  "processing": null,
+  "error": null,
+  "successRate": 91.67,
+  "period": null,
+  "dateFrom": null,
+  "dateTo": null,
+} satisfies EcfStatsResponse
+
+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 EcfStatsResponse
+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/EcfStatusResponse.md

@@ -0,0 +1,56 @@
+
+# EcfStatusResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`trackingId` | string
+`estado` | string
+`trackId` | string
+`numeroControl` | string
+`status` | [DocumentStatus](DocumentStatus.md)
+`encf` | string
+`businessRnc` | string
+`environment` | [Environment](Environment.md)
+`receivedAt` | Date
+`mensajes` | [Array<EcfStatusResponseMensajesInner>](EcfStatusResponseMensajesInner.md)
+`logs` | [Array<ProcessingLog>](ProcessingLog.md)
+`source` | string
+
+## Example
+
+```typescript
+import type { EcfStatusResponse } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "trackingId": null,
+  "estado": null,
+  "trackId": null,
+  "numeroControl": null,
+  "status": null,
+  "encf": null,
+  "businessRnc": null,
+  "environment": null,
+  "receivedAt": null,
+  "mensajes": null,
+  "logs": null,
+  "source": null,
+} satisfies EcfStatusResponse
+
+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 EcfStatusResponse
+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/EcfStatusResponseMensajesInner.md

@@ -0,0 +1,36 @@
+
+# EcfStatusResponseMensajesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`codigo` | string
+`valor` | string
+
+## Example
+
+```typescript
+import type { EcfStatusResponseMensajesInner } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "codigo": null,
+  "valor": null,
+} satisfies EcfStatusResponseMensajesInner
+
+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 EcfStatusResponseMensajesInner
+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/EcfSubmissionResponse.md

@@ -1,7 +1,7 @@
 
 # EcfSubmissionResponse
 
-Response returned after successfully submitting an e-CF document.
+Response after submitting an e-CF. HTTP 200 even when rejected. Check the success field and dgiiResponse.estado for actual result. 
 
 ## Properties
 
@@ -9,22 +9,40 @@ Name | Type
 ------------ | -------------
 `success` | boolean
 `documentId` | string
+`dgiiResponse` | [EcfSubmissionResponseDgiiResponse](EcfSubmissionResponseDgiiResponse.md)
+`qrUrl` | string
+`signatureTime` | Date
+`securityCode` | string
 `encf` | string
-`trackId` | string
+`documentType` | string
+`printUrl` | string
+`authType` | string
+`timestamp` | Date
 `message` | string
+`contingencyMode` | boolean
+`estimatedProcessTime` | string
 
 ## Example
 
 ```typescript
-import type { EcfSubmissionResponse } from '@pronesoft/ecf-sdk'
+import type { EcfSubmissionResponse } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "success": null,
   "documentId": null,
+  "dgiiResponse": null,
+  "qrUrl": null,
+  "signatureTime": null,
+  "securityCode": A1B2C3,
   "encf": E310000000001,
-  "trackId": TRK-20240101-0001,
+  "documentType": E31,
+  "printUrl": null,
+  "authType": api_key,
+  "timestamp": null,
   "message": null,
+  "contingencyMode": null,
+  "estimatedProcessTime": null,
 } satisfies EcfSubmissionResponse
 
 console.log(example)

package/docs/EcfSubmissionResponseDgiiResponse.md

@@ -0,0 +1,40 @@
+
+# EcfSubmissionResponseDgiiResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`estado` | string
+`trackId` | string
+`codigoError` | string
+`mensaje` | string
+
+## Example
+
+```typescript
+import type { EcfSubmissionResponseDgiiResponse } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "estado": null,
+  "trackId": null,
+  "codigoError": null,
+  "mensaje": null,
+} satisfies EcfSubmissionResponseDgiiResponse
+
+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 EcfSubmissionResponseDgiiResponse
+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/ElectronicDocument.md

@@ -1,29 +1,49 @@
 
 # ElectronicDocument
 
-The main e-CF document payload. Build this object and submit it to `POST /{environment}/ecf/submit`.  **Required fields:** `version`, `invoiceType`, `invoiceNumber`, `issueDate`, `items`, `totals`.  Use `GET /tax-sequences/next` to obtain the correct `invoiceNumber`. 
+Electronic tax document (e-CF) payload. Use GET /tax-sequences/next to obtain invoiceNumber. paymentForms is always required. 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`version` | string
+`environment` | [Environment](Environment.md)
+`version` | number
 `invoiceType` | [InvoiceType](InvoiceType.md)
 `invoiceNumber` | string
 `issueDate` | Date
 `expirationDate` | Date
+`creditNoteIndicator` | string
+`deferredSendingIndicator` | string
+`taxedAmountIndicator` | string
 `incomeType` | string
 `paymentType` | string
 `paymentDeadline` | Date
 `paymentTerms` | string
+`paymentForms` | [Array<PaymentForm>](PaymentForm.md)
 `paymentAccountType` | [AccountType](AccountType.md)
 `paymentAccountNumber` | string
 `paymentBank` | string
-`creditNoteIndicator` | string
+`serviceStartDate` | Date
+`serviceEndDate` | Date
+`totalPages` | number
 `issuerRNC` | string
 `issuerBusinessName` | string
-`issuerEmail` | string
+`issuerCommercialName` | string
+`branchName` | string
+`issuerAddress` | string
+`municipalityCode` | string
+`provinceCode` | string
 `issuerPhones` | Array<string>
+`issuerEmail` | string
+`issuerWebsite` | string
+`issuerEconomicActivity` | string
+`sellerCode` | string
+`internalInvoiceNumber` | string
+`internalOrderNumber` | number
+`salesZone` | string
+`salesRoute` | string
+`additionalIssuerInfo` | string
 `buyer` | [Buyer](Buyer.md)
 `items` | [Array<Item>](Item.md)
 `totals` | [Totals](Totals.md)
@@ -31,34 +51,54 @@ Name | Type
 `additionalInfo` | [AdditionalInfo](AdditionalInfo.md)
 `alternativeCurrency` | [AlternativeCurrency](AlternativeCurrency.md)
 `referenceInfo` | [ReferenceInfo](ReferenceInfo.md)
-`subtotals` | [Array<Subtotal>](Subtotal.md)
+`subtotals` | [Subtotal](Subtotal.md)
 `discountsOrSurcharges` | [Array<DiscountOrSurcharge>](DiscountOrSurcharge.md)
-`pages` | [Array<Page>](Page.md)
+`pages` | [Page](Page.md)
 
 ## Example
 
 ```typescript
-import type { ElectronicDocument } from '@pronesoft/ecf-sdk'
+import type { ElectronicDocument } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "version": 1.0,
+  "environment": null,
+  "version": 1,
   "invoiceType": null,
   "invoiceNumber": E310000000001,
-  "issueDate": 2024-01-15T10:30Z,
-  "expirationDate": 2024-02-15T10:30Z,
+  "issueDate": 2025-01-15T10:30Z,
+  "expirationDate": null,
+  "creditNoteIndicator": null,
+  "deferredSendingIndicator": null,
+  "taxedAmountIndicator": null,
   "incomeType": null,
   "paymentType": null,
   "paymentDeadline": null,
   "paymentTerms": null,
+  "paymentForms": [{"method":"1","amount":11800.0}],
   "paymentAccountType": null,
   "paymentAccountNumber": null,
   "paymentBank": null,
-  "creditNoteIndicator": null,
+  "serviceStartDate": null,
+  "serviceEndDate": null,
+  "totalPages": null,
   "issuerRNC": null,
   "issuerBusinessName": null,
-  "issuerEmail": null,
+  "issuerCommercialName": null,
+  "branchName": null,
+  "issuerAddress": null,
+  "municipalityCode": null,
+  "provinceCode": null,
   "issuerPhones": null,
+  "issuerEmail": null,
+  "issuerWebsite": null,
+  "issuerEconomicActivity": null,
+  "sellerCode": null,
+  "internalInvoiceNumber": null,
+  "internalOrderNumber": null,
+  "salesZone": null,
+  "salesRoute": null,
+  "additionalIssuerInfo": null,
   "buyer": null,
   "items": null,
   "totals": null,

package/docs/Environment.md

@@ -1,7 +1,7 @@
 
 # Environment
 
-Target environment for e-CF submission. - `TesteCF`: Functional tests, no real DGII interaction. - `CerteCF`: DGII certification environment. - `eCF`: Production — issues real legal documents. 
+TesteCF=testing no DGII, CerteCF=official certification, eCF=production
 
 ## Properties
 
@@ -11,7 +11,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { Environment } from '@pronesoft/ecf-sdk'
+import type { Environment } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ErrorResponse.md

@@ -1,7 +1,6 @@
 
 # ErrorResponse
 
-Standard error response returned by all endpoints on failure.
 
 ## Properties
 
@@ -9,18 +8,20 @@ Name | Type
 ------------ | -------------
 `statusCode` | number
 `message` | string
+`error` | string
 `timestamp` | Date
 
 ## Example
 
 ```typescript
-import type { ErrorResponse } from '@pronesoft/ecf-sdk'
+import type { ErrorResponse } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "statusCode": 400,
-  "message": invoiceNumber must match pattern ^[a-zA-Z0-9]{13}$,
-  "timestamp": 2024-01-01T12:00Z,
+  "statusCode": null,
+  "message": null,
+  "error": null,
+  "timestamp": null,
 } satisfies ErrorResponse
 
 console.log(example)

package/docs/GetNextNumber200Response.md

@@ -12,7 +12,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { GetNextNumber200Response } from '@pronesoft/ecf-sdk'
+import type { GetNextNumber200Response } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/GetNextNumber200ResponseData.md

@@ -7,17 +7,19 @@
 Name | Type
 ------------ | -------------
 `nextNumber` | string
+`sequenceId` | string
 `remainingNumbers` | number
 
 ## Example
 
 ```typescript
-import type { GetNextNumber200ResponseData } from '@pronesoft/ecf-sdk'
+import type { GetNextNumber200ResponseData } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "nextNumber": E310000000001,
-  "remainingNumbers": 499,
+  "nextNumber": E32000005251,
+  "sequenceId": seq_live_1234567890,
+  "remainingNumbers": 4750,
 } satisfies GetNextNumber200ResponseData
 
 console.log(example)

package/docs/InvoiceType.md

@@ -1,7 +1,7 @@
 
 # InvoiceType
 
-e-NCF invoice type code as defined by the DGII: - `31`: Tax Credit Invoice (Factura de Crédito Fiscal) - `32`: Consumer Invoice (Factura de Consumo) - `33`: Debit Note (Nota de Débito) - `34`: Credit Note (Nota de Crédito) - `41`: Purchases (Compras) - `43`: Minor Expenses (Gastos Menores) - `44`: Special Regimes (Regímenes Especiales) - `45`: Governmental (Gubernamentales) - `46`: Exports (Exportaciones) - `47`: Overseas Payments (Pagos al Exterior) 
+31=Factura Credito Fiscal, 32=Factura Consumo, 33=Nota Debito, 34=Nota Credito, 41=Compras, 43=Gastos Menores, 44=Regimenes Especiales, 45=Gubernamental, 46=Exportaciones, 47=Pagos Exterior 
 
 ## Properties
 
@@ -11,7 +11,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { InvoiceType } from '@pronesoft/ecf-sdk'
+import type { InvoiceType } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/InvoiceTypeSequence.md

@@ -0,0 +1,33 @@
+
+# InvoiceTypeSequence
+
+Invoice type with E prefix — used for tax sequence endpoints.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { InvoiceTypeSequence } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies InvoiceTypeSequence
+
+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 InvoiceTypeSequence
+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/Item.md

@@ -1,42 +1,73 @@
 
 # Item
 
-A single line item in the electronic document.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `lineNumber` | number
+`codes` | [Array<ItemCodesInner>](ItemCodesInner.md)
 `name` | string
+`description` | string
 `type` | string
 `billingIndicator` | [BillingIndicator](BillingIndicator.md)
+`withholdingAgentIndicator` | number
+`withheldITBISAmount` | number
+`withheldISRAmount` | number
 `quantity` | string
+`unitOfMeasure` | number
+`referenceQuantity` | number
+`referenceUnit` | number
+`referenceUnitPrice` | number
+`subquantities` | [Array<Subquantity>](Subquantity.md)
+`alcoholDegree` | number
+`manufacturingDate` | Date
+`expirationDate` | Date
+`miningInfo` | [ItemMiningInfo](ItemMiningInfo.md)
 `unitPrice` | string
-`amount` | number
 `discountAmount` | number
+`discount` | [Array<ItemDiscountInner>](ItemDiscountInner.md)
+`surchargeAmount` | number
+`surcharge` | [Array<ItemDiscountInner>](ItemDiscountInner.md)
 `additionalTaxes` | [Array<ItemAdditionalTax>](ItemAdditionalTax.md)
-`subquantities` | [Array<Subquantity>](Subquantity.md)
-`alcoholDegree` | number
+`alternativeCurrency` | [ItemAlternativeCurrency](ItemAlternativeCurrency.md)
+`amount` | number
 
 ## Example
 
 ```typescript
-import type { Item } from '@pronesoft/ecf-sdk'
+import type { Item } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "lineNumber": 1,
-  "name": Consulting Services,
+  "codes": null,
+  "name": Servicio profesional,
+  "description": null,
   "type": null,
   "billingIndicator": null,
-  "quantity": 2.5,
-  "unitPrice": 1500.00,
-  "amount": 3750.0,
-  "discountAmount": 0.0,
-  "additionalTaxes": null,
+  "withholdingAgentIndicator": null,
+  "withheldITBISAmount": null,
+  "withheldISRAmount": null,
+  "quantity": 1,
+  "unitOfMeasure": null,
+  "referenceQuantity": null,
+  "referenceUnit": null,
+  "referenceUnitPrice": null,
   "subquantities": null,
   "alcoholDegree": null,
+  "manufacturingDate": null,
+  "expirationDate": null,
+  "miningInfo": null,
+  "unitPrice": 10000.00,
+  "discountAmount": null,
+  "discount": null,
+  "surchargeAmount": null,
+  "surcharge": null,
+  "additionalTaxes": null,
+  "alternativeCurrency": null,
+  "amount": 10000.0,
 } satisfies Item
 
 console.log(example)

package/docs/ItemAdditionalTax.md

@@ -1,7 +1,6 @@
 
 # ItemAdditionalTax
 
-An additional tax applied to a line item (e.g. ISC, IECS).
 
 ## Properties
 
@@ -13,7 +12,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ItemAdditionalTax } from '@pronesoft/ecf-sdk'
+import type { ItemAdditionalTax } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ItemAlternativeCurrency.md

@@ -0,0 +1,40 @@
+
+# ItemAlternativeCurrency
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`unitPrice` | number
+`discount` | number
+`surcharge` | number
+`amount` | number
+
+## Example
+
+```typescript
+import type { ItemAlternativeCurrency } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "unitPrice": null,
+  "discount": null,
+  "surcharge": null,
+  "amount": null,
+} satisfies ItemAlternativeCurrency
+
+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 ItemAlternativeCurrency
+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/ItemCodesInner.md

@@ -0,0 +1,36 @@
+
+# ItemCodesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`codeType` | string
+`code` | string
+
+## Example
+
+```typescript
+import type { ItemCodesInner } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "codeType": null,
+  "code": null,
+} satisfies ItemCodesInner
+
+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 ItemCodesInner
+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)
+
+