@pronesoft-rd/ecf-sdk 0.0.1

package/docs/ElectronicDocument.md

@@ -0,0 +1,87 @@
+
+# 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`. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`version` | string
+`invoiceType` | [InvoiceType](InvoiceType.md)
+`invoiceNumber` | string
+`issueDate` | Date
+`expirationDate` | Date
+`incomeType` | string
+`paymentType` | string
+`paymentDeadline` | Date
+`paymentTerms` | string
+`paymentAccountType` | [AccountType](AccountType.md)
+`paymentAccountNumber` | string
+`paymentBank` | string
+`creditNoteIndicator` | string
+`issuerRNC` | string
+`issuerBusinessName` | string
+`issuerEmail` | string
+`issuerPhones` | Array<string>
+`buyer` | [Buyer](Buyer.md)
+`items` | [Array<Item>](Item.md)
+`totals` | [Totals](Totals.md)
+`transport` | [Transport](Transport.md)
+`additionalInfo` | [AdditionalInfo](AdditionalInfo.md)
+`alternativeCurrency` | [AlternativeCurrency](AlternativeCurrency.md)
+`referenceInfo` | [ReferenceInfo](ReferenceInfo.md)
+`subtotals` | [Array<Subtotal>](Subtotal.md)
+`discountsOrSurcharges` | [Array<DiscountOrSurcharge>](DiscountOrSurcharge.md)
+`pages` | [Array<Page>](Page.md)
+
+## Example
+
+```typescript
+import type { ElectronicDocument } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "version": 1.0,
+  "invoiceType": null,
+  "invoiceNumber": E310000000001,
+  "issueDate": 2024-01-15T10:30Z,
+  "expirationDate": 2024-02-15T10:30Z,
+  "incomeType": null,
+  "paymentType": null,
+  "paymentDeadline": null,
+  "paymentTerms": null,
+  "paymentAccountType": null,
+  "paymentAccountNumber": null,
+  "paymentBank": null,
+  "creditNoteIndicator": null,
+  "issuerRNC": null,
+  "issuerBusinessName": null,
+  "issuerEmail": null,
+  "issuerPhones": null,
+  "buyer": null,
+  "items": null,
+  "totals": null,
+  "transport": null,
+  "additionalInfo": null,
+  "alternativeCurrency": null,
+  "referenceInfo": null,
+  "subtotals": null,
+  "discountsOrSurcharges": null,
+  "pages": null,
+} satisfies ElectronicDocument
+
+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 ElectronicDocument
+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/Environment.md

@@ -0,0 +1,33 @@
+
+# Environment
+
+Target environment for e-CF submission. - `TesteCF`: Functional tests, no real DGII interaction. - `CerteCF`: DGII certification environment. - `eCF`: Production — issues real legal documents. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { Environment } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies Environment
+
+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 Environment
+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/ErrorResponse.md

@@ -0,0 +1,39 @@
+
+# ErrorResponse
+
+Standard error response returned by all endpoints on failure.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`statusCode` | number
+`message` | string
+`timestamp` | Date
+
+## Example
+
+```typescript
+import type { ErrorResponse } from '@pronesoft/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,
+} satisfies ErrorResponse
+
+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 ErrorResponse
+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/GetNextNumber200Response.md

@@ -0,0 +1,36 @@
+
+# GetNextNumber200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [GetNextNumber200ResponseData](GetNextNumber200ResponseData.md)
+
+## Example
+
+```typescript
+import type { GetNextNumber200Response } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies GetNextNumber200Response
+
+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 GetNextNumber200Response
+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/GetNextNumber200ResponseData.md

@@ -0,0 +1,36 @@
+
+# GetNextNumber200ResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nextNumber` | string
+`remainingNumbers` | number
+
+## Example
+
+```typescript
+import type { GetNextNumber200ResponseData } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nextNumber": E310000000001,
+  "remainingNumbers": 499,
+} satisfies GetNextNumber200ResponseData
+
+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 GetNextNumber200ResponseData
+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/InvoiceType.md

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

@@ -0,0 +1,55 @@
+
+# Item
+
+A single line item in the electronic document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`lineNumber` | number
+`name` | string
+`type` | string
+`billingIndicator` | [BillingIndicator](BillingIndicator.md)
+`quantity` | string
+`unitPrice` | string
+`amount` | number
+`discountAmount` | number
+`additionalTaxes` | [Array<ItemAdditionalTax>](ItemAdditionalTax.md)
+`subquantities` | [Array<Subquantity>](Subquantity.md)
+`alcoholDegree` | number
+
+## Example
+
+```typescript
+import type { Item } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "lineNumber": 1,
+  "name": Consulting Services,
+  "type": null,
+  "billingIndicator": null,
+  "quantity": 2.5,
+  "unitPrice": 1500.00,
+  "amount": 3750.0,
+  "discountAmount": 0.0,
+  "additionalTaxes": null,
+  "subquantities": null,
+  "alcoholDegree": null,
+} satisfies Item
+
+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 Item
+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/ItemAdditionalTax.md

@@ -0,0 +1,37 @@
+
+# ItemAdditionalTax
+
+An additional tax applied to a line item (e.g. ISC, IECS).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`amount` | number
+
+## Example
+
+```typescript
+import type { ItemAdditionalTax } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "amount": null,
+} satisfies ItemAdditionalTax
+
+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 ItemAdditionalTax
+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/ListTaxSequences200Response.md

@@ -0,0 +1,36 @@
+
+# ListTaxSequences200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [Array<TaxSequence>](TaxSequence.md)
+
+## Example
+
+```typescript
+import type { ListTaxSequences200Response } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies ListTaxSequences200Response
+
+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 ListTaxSequences200Response
+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/OAuthTokenRequest.md

@@ -0,0 +1,37 @@
+
+# OAuthTokenRequest
+
+Credentials for OAuth 2.0 Client Credentials authentication.  Obtain `clientId` and `clientSecret` from the Pronesoft portal: - Sandbox: https://ecf.sandbox.pronesoft.com - Production: https://ecf.pronesoft.com 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clientId` | string
+`clientSecret` | string
+
+## Example
+
+```typescript
+import type { OAuthTokenRequest } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clientId": my-app-client-id,
+  "clientSecret": my-super-secret-value,
+} satisfies OAuthTokenRequest
+
+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 OAuthTokenRequest
+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/OAuthTokenResponse.md

@@ -0,0 +1,39 @@
+
+# OAuthTokenResponse
+
+Successful token response. Use `accessToken` as a Bearer token in the `Authorization` header of all subsequent requests. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`accessToken` | string
+`tokenType` | string
+`expiresIn` | number
+
+## Example
+
+```typescript
+import type { OAuthTokenResponse } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "accessToken": eyJhbGciOiJSUzI1NiJ9...,
+  "tokenType": Bearer,
+  "expiresIn": 3600,
+} satisfies OAuthTokenResponse
+
+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 OAuthTokenResponse
+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/Page.md

@@ -0,0 +1,63 @@
+
+# Page
+
+Page-level breakdown for multi-page documents.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pageNumber` | number
+`lineFrom` | number
+`lineTo` | number
+`subtotal` | number
+`taxableAmount` | number
+`taxableAmount1` | number
+`taxableAmount2` | number
+`taxableAmount3` | number
+`totalITBIS` | number
+`itbis1` | number
+`itbis2` | number
+`itbis3` | number
+`additionalTaxes` | number
+`exemptAmount` | number
+`nonBillableAmount` | number
+
+## Example
+
+```typescript
+import type { Page } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pageNumber": null,
+  "lineFrom": null,
+  "lineTo": null,
+  "subtotal": null,
+  "taxableAmount": null,
+  "taxableAmount1": null,
+  "taxableAmount2": null,
+  "taxableAmount3": null,
+  "totalITBIS": null,
+  "itbis1": null,
+  "itbis2": null,
+  "itbis3": null,
+  "additionalTaxes": null,
+  "exemptAmount": null,
+  "nonBillableAmount": null,
+} satisfies Page
+
+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 Page
+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/PaymentMethod.md

@@ -0,0 +1,33 @@
+
+# PaymentMethod
+
+Payment method code: - `1`: Cash (Efectivo) - `2`: Check (Cheque) - `3`: Debit/Credit Card (Tarjeta de Débito/Crédito) - `4`: Credit (Crédito) - `5`: Bank Transfer (Transferencia Bancaria) - `6`: Electronic Money (Dinero Electrónico) - `7`: Bond/Gift Card (Bono/Gift Card) - `8`: Other (Otro) 
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PaymentMethod } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PaymentMethod
+
+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 PaymentMethod
+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/PrintFormat.md

@@ -0,0 +1,33 @@
+
+# PrintFormat
+
+Printer/receipt format: - `A4`: Standard A4 paper - `thermal_80`: 80mm thermal printer - `thermal_58`: 58mm thermal printer 
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PrintFormat } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PrintFormat
+
+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 PrintFormat
+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/ReferenceInfo.md

@@ -0,0 +1,43 @@
+
+# ReferenceInfo
+
+Reference to a previously issued document. Required for: - Credit Notes (type 34) — references the original invoice - Debit Notes (type 33) — references the original invoice 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`modifiedInvoiceNumber` | string
+`otherContributorRNC` | string
+`modifiedInvoiceDate` | Date
+`modificationCode` | string
+`modificationReason` | string
+
+## Example
+
+```typescript
+import type { ReferenceInfo } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "modifiedInvoiceNumber": E310000000001,
+  "otherContributorRNC": null,
+  "modifiedInvoiceDate": null,
+  "modificationCode": null,
+  "modificationReason": null,
+} satisfies ReferenceInfo
+
+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 ReferenceInfo
+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/Subquantity.md

@@ -0,0 +1,37 @@
+
+# Subquantity
+
+Sub-quantity for items measured in multiple units.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`quantity` | number
+`unitCode` | number
+
+## Example
+
+```typescript
+import type { Subquantity } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "quantity": null,
+  "unitCode": null,
+} satisfies Subquantity
+
+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 Subquantity
+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)
+
+