@pronesoft-rd/ecf-sdk 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +96 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +234 -0
- package/dist/apis/AssociatedCompaniesApi.d.ts +150 -0
- package/dist/apis/AssociatedCompaniesApi.js +229 -0
- package/dist/apis/AuthenticationApi.d.ts +64 -0
- package/dist/apis/AuthenticationApi.js +75 -0
- package/dist/apis/DigitalCertificatesApi.d.ts +70 -0
- package/dist/apis/DigitalCertificatesApi.js +113 -0
- package/dist/apis/ECFSubmissionApi.d.ts +70 -0
- package/dist/apis/ECFSubmissionApi.js +96 -0
- package/dist/apis/TaxSequencesApi.d.ts +152 -0
- package/dist/apis/TaxSequencesApi.js +214 -0
- package/dist/apis/WebhookConfigurationApi.d.ts +146 -0
- package/dist/apis/WebhookConfigurationApi.js +197 -0
- package/dist/apis/index.d.ts +6 -0
- package/dist/apis/index.js +24 -0
- package/dist/esm/apis/AssociatedCompaniesApi.d.ts +150 -0
- package/dist/esm/apis/AssociatedCompaniesApi.js +225 -0
- package/dist/esm/apis/AuthenticationApi.d.ts +64 -0
- package/dist/esm/apis/AuthenticationApi.js +71 -0
- package/dist/esm/apis/DigitalCertificatesApi.d.ts +70 -0
- package/dist/esm/apis/DigitalCertificatesApi.js +109 -0
- package/dist/esm/apis/ECFSubmissionApi.d.ts +70 -0
- package/dist/esm/apis/ECFSubmissionApi.js +92 -0
- package/dist/esm/apis/TaxSequencesApi.d.ts +152 -0
- package/dist/esm/apis/TaxSequencesApi.js +210 -0
- package/dist/esm/apis/WebhookConfigurationApi.d.ts +146 -0
- package/dist/esm/apis/WebhookConfigurationApi.js +193 -0
- package/dist/esm/apis/index.d.ts +6 -0
- package/dist/esm/apis/index.js +8 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/AccountType.d.ts +30 -0
- package/dist/esm/models/AccountType.js +48 -0
- package/dist/esm/models/AdditionalInfo.d.ts +50 -0
- package/dist/esm/models/AdditionalInfo.js +47 -0
- package/dist/esm/models/AlternativeCurrency.d.ts +46 -0
- package/dist/esm/models/AlternativeCurrency.js +49 -0
- package/dist/esm/models/AssociatedCompany.d.ts +125 -0
- package/dist/esm/models/AssociatedCompany.js +77 -0
- package/dist/esm/models/AssociatedCompanySubscription.d.ts +45 -0
- package/dist/esm/models/AssociatedCompanySubscription.js +46 -0
- package/dist/esm/models/AssociatedCompanySubscriptionPlan.d.ts +38 -0
- package/dist/esm/models/AssociatedCompanySubscriptionPlan.js +43 -0
- package/dist/esm/models/BillingIndicator.d.ts +34 -0
- package/dist/esm/models/BillingIndicator.js +52 -0
- package/dist/esm/models/Buyer.d.ts +68 -0
- package/dist/esm/models/Buyer.js +55 -0
- package/dist/esm/models/CreateAssociatedCompany201Response.d.ts +39 -0
- package/dist/esm/models/CreateAssociatedCompany201Response.js +44 -0
- package/dist/esm/models/CreateTaxSequenceRequest.d.ts +47 -0
- package/dist/esm/models/CreateTaxSequenceRequest.js +52 -0
- package/dist/esm/models/CreateWebhookConfig.d.ts +53 -0
- package/dist/esm/models/CreateWebhookConfig.js +52 -0
- package/dist/esm/models/DiscountOrSurcharge.d.ts +93 -0
- package/dist/esm/models/DiscountOrSurcharge.js +78 -0
- package/dist/esm/models/EcfSubmissionResponse.d.ts +56 -0
- package/dist/esm/models/EcfSubmissionResponse.js +53 -0
- package/dist/esm/models/ElectronicDocument.d.ts +252 -0
- package/dist/esm/models/ElectronicDocument.js +143 -0
- package/dist/esm/models/Environment.d.ts +30 -0
- package/dist/esm/models/Environment.js +48 -0
- package/dist/esm/models/ErrorResponse.d.ts +44 -0
- package/dist/esm/models/ErrorResponse.js +45 -0
- package/dist/esm/models/GetNextNumber200Response.d.ts +39 -0
- package/dist/esm/models/GetNextNumber200Response.js +44 -0
- package/dist/esm/models/GetNextNumber200ResponseData.d.ts +38 -0
- package/dist/esm/models/GetNextNumber200ResponseData.js +43 -0
- package/dist/esm/models/InvoiceType.d.ts +44 -0
- package/dist/esm/models/InvoiceType.js +62 -0
- package/dist/esm/models/Item.d.ts +106 -0
- package/dist/esm/models/Item.js +83 -0
- package/dist/esm/models/ItemAdditionalTax.d.ts +38 -0
- package/dist/esm/models/ItemAdditionalTax.js +47 -0
- package/dist/esm/models/ListTaxSequences200Response.d.ts +39 -0
- package/dist/esm/models/ListTaxSequences200Response.js +44 -0
- package/dist/esm/models/OAuthTokenRequest.d.ts +43 -0
- package/dist/esm/models/OAuthTokenRequest.js +47 -0
- package/dist/esm/models/OAuthTokenResponse.d.ts +46 -0
- package/dist/esm/models/OAuthTokenResponse.js +45 -0
- package/dist/esm/models/Page.d.ts +116 -0
- package/dist/esm/models/Page.js +75 -0
- package/dist/esm/models/PaymentMethod.d.ts +40 -0
- package/dist/esm/models/PaymentMethod.js +58 -0
- package/dist/esm/models/PrintFormat.d.ts +30 -0
- package/dist/esm/models/PrintFormat.js +48 -0
- package/dist/esm/models/ReferenceInfo.d.ts +76 -0
- package/dist/esm/models/ReferenceInfo.js +63 -0
- package/dist/esm/models/Subquantity.d.ts +38 -0
- package/dist/esm/models/Subquantity.js +47 -0
- package/dist/esm/models/Subtotal.d.ts +110 -0
- package/dist/esm/models/Subtotal.js +71 -0
- package/dist/esm/models/TaxSequence.d.ts +45 -0
- package/dist/esm/models/TaxSequence.js +46 -0
- package/dist/esm/models/Totals.d.ts +173 -0
- package/dist/esm/models/Totals.js +90 -0
- package/dist/esm/models/Transport.d.ts +62 -0
- package/dist/esm/models/Transport.js +51 -0
- package/dist/esm/models/UploadCertificate201Response.d.ts +44 -0
- package/dist/esm/models/UploadCertificate201Response.js +45 -0
- package/dist/esm/models/UploadCertificateResponse.d.ts +44 -0
- package/dist/esm/models/UploadCertificateResponse.js +45 -0
- package/dist/esm/models/WebhookConfigResponse.d.ts +63 -0
- package/dist/esm/models/WebhookConfigResponse.js +52 -0
- package/dist/esm/models/WebhookEventType.d.ts +40 -0
- package/dist/esm/models/WebhookEventType.js +58 -0
- package/dist/esm/models/WebhookNotificationPayload.d.ts +59 -0
- package/dist/esm/models/WebhookNotificationPayload.js +60 -0
- package/dist/esm/models/index.d.ts +37 -0
- package/dist/esm/models/index.js +39 -0
- package/dist/esm/runtime.d.ts +184 -0
- package/dist/esm/runtime.js +349 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/AccountType.d.ts +30 -0
- package/dist/models/AccountType.js +56 -0
- package/dist/models/AdditionalInfo.d.ts +50 -0
- package/dist/models/AdditionalInfo.js +54 -0
- package/dist/models/AlternativeCurrency.d.ts +46 -0
- package/dist/models/AlternativeCurrency.js +56 -0
- package/dist/models/AssociatedCompany.d.ts +125 -0
- package/dist/models/AssociatedCompany.js +85 -0
- package/dist/models/AssociatedCompanySubscription.d.ts +45 -0
- package/dist/models/AssociatedCompanySubscription.js +53 -0
- package/dist/models/AssociatedCompanySubscriptionPlan.d.ts +38 -0
- package/dist/models/AssociatedCompanySubscriptionPlan.js +50 -0
- package/dist/models/BillingIndicator.d.ts +34 -0
- package/dist/models/BillingIndicator.js +60 -0
- package/dist/models/Buyer.d.ts +68 -0
- package/dist/models/Buyer.js +62 -0
- package/dist/models/CreateAssociatedCompany201Response.d.ts +39 -0
- package/dist/models/CreateAssociatedCompany201Response.js +51 -0
- package/dist/models/CreateTaxSequenceRequest.d.ts +47 -0
- package/dist/models/CreateTaxSequenceRequest.js +59 -0
- package/dist/models/CreateWebhookConfig.d.ts +53 -0
- package/dist/models/CreateWebhookConfig.js +59 -0
- package/dist/models/DiscountOrSurcharge.d.ts +93 -0
- package/dist/models/DiscountOrSurcharge.js +86 -0
- package/dist/models/EcfSubmissionResponse.d.ts +56 -0
- package/dist/models/EcfSubmissionResponse.js +60 -0
- package/dist/models/ElectronicDocument.d.ts +252 -0
- package/dist/models/ElectronicDocument.js +151 -0
- package/dist/models/Environment.d.ts +30 -0
- package/dist/models/Environment.js +56 -0
- package/dist/models/ErrorResponse.d.ts +44 -0
- package/dist/models/ErrorResponse.js +52 -0
- package/dist/models/GetNextNumber200Response.d.ts +39 -0
- package/dist/models/GetNextNumber200Response.js +51 -0
- package/dist/models/GetNextNumber200ResponseData.d.ts +38 -0
- package/dist/models/GetNextNumber200ResponseData.js +50 -0
- package/dist/models/InvoiceType.d.ts +44 -0
- package/dist/models/InvoiceType.js +70 -0
- package/dist/models/Item.d.ts +106 -0
- package/dist/models/Item.js +91 -0
- package/dist/models/ItemAdditionalTax.d.ts +38 -0
- package/dist/models/ItemAdditionalTax.js +54 -0
- package/dist/models/ListTaxSequences200Response.d.ts +39 -0
- package/dist/models/ListTaxSequences200Response.js +51 -0
- package/dist/models/OAuthTokenRequest.d.ts +43 -0
- package/dist/models/OAuthTokenRequest.js +54 -0
- package/dist/models/OAuthTokenResponse.d.ts +46 -0
- package/dist/models/OAuthTokenResponse.js +52 -0
- package/dist/models/Page.d.ts +116 -0
- package/dist/models/Page.js +82 -0
- package/dist/models/PaymentMethod.d.ts +40 -0
- package/dist/models/PaymentMethod.js +66 -0
- package/dist/models/PrintFormat.d.ts +30 -0
- package/dist/models/PrintFormat.js +56 -0
- package/dist/models/ReferenceInfo.d.ts +76 -0
- package/dist/models/ReferenceInfo.js +71 -0
- package/dist/models/Subquantity.d.ts +38 -0
- package/dist/models/Subquantity.js +54 -0
- package/dist/models/Subtotal.d.ts +110 -0
- package/dist/models/Subtotal.js +78 -0
- package/dist/models/TaxSequence.d.ts +45 -0
- package/dist/models/TaxSequence.js +53 -0
- package/dist/models/Totals.d.ts +173 -0
- package/dist/models/Totals.js +97 -0
- package/dist/models/Transport.d.ts +62 -0
- package/dist/models/Transport.js +58 -0
- package/dist/models/UploadCertificate201Response.d.ts +44 -0
- package/dist/models/UploadCertificate201Response.js +52 -0
- package/dist/models/UploadCertificateResponse.d.ts +44 -0
- package/dist/models/UploadCertificateResponse.js +52 -0
- package/dist/models/WebhookConfigResponse.d.ts +63 -0
- package/dist/models/WebhookConfigResponse.js +59 -0
- package/dist/models/WebhookEventType.d.ts +40 -0
- package/dist/models/WebhookEventType.js +66 -0
- package/dist/models/WebhookNotificationPayload.d.ts +59 -0
- package/dist/models/WebhookNotificationPayload.js +67 -0
- package/dist/models/index.d.ts +37 -0
- package/dist/models/index.js +55 -0
- package/dist/runtime.d.ts +184 -0
- package/dist/runtime.js +365 -0
- package/docs/AccountType.md +33 -0
- package/docs/AdditionalInfo.md +41 -0
- package/docs/AlternativeCurrency.md +39 -0
- package/docs/AssociatedCompaniesApi.md +207 -0
- package/docs/AssociatedCompany.md +63 -0
- package/docs/AssociatedCompanySubscription.md +38 -0
- package/docs/AssociatedCompanySubscriptionPlan.md +36 -0
- package/docs/AuthenticationApi.md +77 -0
- package/docs/BillingIndicator.md +33 -0
- package/docs/Buyer.md +47 -0
- package/docs/CreateAssociatedCompany201Response.md +36 -0
- package/docs/CreateTaxSequenceRequest.md +39 -0
- package/docs/CreateWebhookConfig.md +41 -0
- package/docs/DigitalCertificatesApi.md +90 -0
- package/docs/DiscountOrSurcharge.md +49 -0
- package/docs/ECFSubmissionApi.md +90 -0
- package/docs/EcfSubmissionResponse.md +43 -0
- package/docs/ElectronicDocument.md +87 -0
- package/docs/Environment.md +33 -0
- package/docs/ErrorResponse.md +39 -0
- package/docs/GetNextNumber200Response.md +36 -0
- package/docs/GetNextNumber200ResponseData.md +36 -0
- package/docs/InvoiceType.md +33 -0
- package/docs/Item.md +55 -0
- package/docs/ItemAdditionalTax.md +37 -0
- package/docs/ListTaxSequences200Response.md +36 -0
- package/docs/OAuthTokenRequest.md +37 -0
- package/docs/OAuthTokenResponse.md +39 -0
- package/docs/Page.md +63 -0
- package/docs/PaymentMethod.md +33 -0
- package/docs/PrintFormat.md +33 -0
- package/docs/ReferenceInfo.md +43 -0
- package/docs/Subquantity.md +37 -0
- package/docs/Subtotal.md +61 -0
- package/docs/TaxSequence.md +39 -0
- package/docs/TaxSequencesApi.md +246 -0
- package/docs/Totals.md +81 -0
- package/docs/Transport.md +45 -0
- package/docs/UploadCertificate201Response.md +38 -0
- package/docs/UploadCertificateResponse.md +39 -0
- package/docs/WebhookConfigResponse.md +45 -0
- package/docs/WebhookConfigurationApi.md +241 -0
- package/docs/WebhookEventType.md +33 -0
- package/docs/WebhookNotificationPayload.md +43 -0
- package/package.json +21 -0
- package/src/apis/AssociatedCompaniesApi.ts +415 -0
- package/src/apis/AuthenticationApi.ts +122 -0
- package/src/apis/DigitalCertificatesApi.ts +175 -0
- package/src/apis/ECFSubmissionApi.ts +163 -0
- package/src/apis/TaxSequencesApi.ts +374 -0
- package/src/apis/WebhookConfigurationApi.ts +332 -0
- package/src/apis/index.ts +8 -0
- package/src/index.ts +5 -0
- package/src/models/AccountType.ts +58 -0
- package/src/models/AdditionalInfo.ts +89 -0
- package/src/models/AlternativeCurrency.ts +85 -0
- package/src/models/AssociatedCompany.ts +196 -0
- package/src/models/AssociatedCompanySubscription.ts +89 -0
- package/src/models/AssociatedCompanySubscriptionPlan.ts +73 -0
- package/src/models/BillingIndicator.ts +62 -0
- package/src/models/Buyer.ts +114 -0
- package/src/models/CreateAssociatedCompany201Response.ts +81 -0
- package/src/models/CreateTaxSequenceRequest.ts +96 -0
- package/src/models/CreateWebhookConfig.ts +101 -0
- package/src/models/DiscountOrSurcharge.ts +155 -0
- package/src/models/EcfSubmissionResponse.ts +99 -0
- package/src/models/ElectronicDocument.ts +421 -0
- package/src/models/Environment.ts +58 -0
- package/src/models/ErrorResponse.ts +81 -0
- package/src/models/GetNextNumber200Response.ts +81 -0
- package/src/models/GetNextNumber200ResponseData.ts +73 -0
- package/src/models/InvoiceType.ts +72 -0
- package/src/models/Item.ts +187 -0
- package/src/models/ItemAdditionalTax.ts +75 -0
- package/src/models/ListTaxSequences200Response.ts +81 -0
- package/src/models/OAuthTokenRequest.ts +80 -0
- package/src/models/OAuthTokenResponse.ts +83 -0
- package/src/models/Page.ts +180 -0
- package/src/models/PaymentMethod.ts +68 -0
- package/src/models/PrintFormat.ts +58 -0
- package/src/models/ReferenceInfo.ts +122 -0
- package/src/models/Subquantity.ts +75 -0
- package/src/models/Subtotal.ts +171 -0
- package/src/models/TaxSequence.ts +91 -0
- package/src/models/Totals.ts +260 -0
- package/src/models/Transport.ts +105 -0
- package/src/models/UploadCertificate201Response.ts +81 -0
- package/src/models/UploadCertificateResponse.ts +81 -0
- package/src/models/WebhookConfigResponse.ts +113 -0
- package/src/models/WebhookEventType.ts +68 -0
- package/src/models/WebhookNotificationPayload.ts +114 -0
- package/src/models/index.ts +39 -0
- package/src/runtime.ts +450 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* eCF-Pronesoft Integration API
|
|
3
|
+
* ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform, which handles all communication with the DGII on your behalf. ## Authentication — OAuth 2.0 Client Credentials This API uses the **OAuth 2.0 Client Credentials** flow. There is no user login — authentication is machine-to-machine using a `clientId` and `clientSecret` issued by the Pronesoft portal. ### Step-by-step 1. **Get credentials**: - Sandbox: https://ecf.sandbox.pronesoft.com - Production: https://ecf.pronesoft.com 2. **Request a token** — call `POST /oauth/token` with your credentials. The server returns an `accessToken` valid for `expiresIn` seconds. 3. **Authorize requests** — include the token in every subsequent request: ``` Authorization: Bearer <accessToken> ``` 4. **Identify your tenant** — include your company/branch UUID in every protected request: ``` x-tenant-id: <your-tenant-uuid> ``` 5. **Refresh** — when the token expires, simply call `POST /oauth/token` again. ### Scopes | Category | Scope | Description | |---|---|---| | **Business** | `business:read` | Read company data | | | `business:create` | Create a new company | | | `business:update` | Update company data | | **Members** | `members:read` | View team members | | | `members:invite` | Invite new members | | | `members:revoke` | Revoke member access | | **Certificates** | `certificates:read` | View digital certificates | | | `certificates:upload` | Upload new certificates | | | `certificates:update` | Update existing certificates | | **Documents** | `documents:read` | List and view documents | | | `documents:create` | Create drafts or internal documents | | | `documents:send` | Submit e-CF to DGII | | | `documents:receive` | Receive e-CF from third parties | | | `documents:update` | Modify document metadata | | **Approvals** | `approvals:read` | View approval statuses | | | `approvals:commercial` | Perform commercial approvals/rejections | | **Sequences** | `sequences:read` | View NCF/e-NCF ranges | | | `sequences:create` | Request new sequences | | | `sequences:update` | Modify sequence configurations | | | `sequences:cancel` | Cancel unused sequences | | **Dashboard** | `business_info:read` | Access dashboard stats and metrics | | **Certification** | `certification:read` | View certification progress | | | `certification:write` | Run automated DGII certification tests | | **Reports** | `reports:read` | Generate and export reports (e.g. 606) | ## Environments | Environment | Portal | API Host | Purpose | |---|---|---|---| | Sandbox | https://ecf.sandbox.pronesoft.com | `api.ecf.sandbox.pronesoft.com` | Development & testing | | Production | https://ecf.pronesoft.com | `api.ecf.pronesoft.com` | Live e-CF issuance | ## Invoice Types (e-NCF) | Code | Name | |---|---| | `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) |
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.0.1
|
|
6
|
+
* Contact: contacto@pronesoft.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { CreateWebhookConfig, WebhookConfigResponse } from '../models/index';
|
|
14
|
+
export interface CreateWebhookRequest {
|
|
15
|
+
rnc: string;
|
|
16
|
+
createWebhookConfig: CreateWebhookConfig;
|
|
17
|
+
}
|
|
18
|
+
export interface DeleteWebhookRequest {
|
|
19
|
+
rnc: string;
|
|
20
|
+
webhookId: string;
|
|
21
|
+
}
|
|
22
|
+
export interface ListWebhooksRequest {
|
|
23
|
+
rnc: string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* WebhookConfigurationApi - interface
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface WebhookConfigurationApiInterface
|
|
30
|
+
*/
|
|
31
|
+
export interface WebhookConfigurationApiInterface {
|
|
32
|
+
/**
|
|
33
|
+
* Creates request options for createWebhook without sending the request
|
|
34
|
+
* @param {string} rnc RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).
|
|
35
|
+
* @param {CreateWebhookConfig} createWebhookConfig
|
|
36
|
+
* @throws {RequiredError}
|
|
37
|
+
* @memberof WebhookConfigurationApiInterface
|
|
38
|
+
*/
|
|
39
|
+
createWebhookRequestOpts(requestParameters: CreateWebhookRequest): Promise<runtime.RequestOpts>;
|
|
40
|
+
/**
|
|
41
|
+
* Registers a URL to receive real-time event notifications for the given RNC. You can subscribe to one or more `WebhookEventType` values. Optionally provide a `secret` (min 16 chars) — Pronesoft will sign webhook payloads with HMAC-SHA256 using this secret so you can verify authenticity on your end.
|
|
42
|
+
* @summary Register new webhook
|
|
43
|
+
* @param {string} rnc RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).
|
|
44
|
+
* @param {CreateWebhookConfig} createWebhookConfig
|
|
45
|
+
* @param {*} [options] Override http request option.
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
* @memberof WebhookConfigurationApiInterface
|
|
48
|
+
*/
|
|
49
|
+
createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookConfigResponse>>;
|
|
50
|
+
/**
|
|
51
|
+
* Registers a URL to receive real-time event notifications for the given RNC. You can subscribe to one or more `WebhookEventType` values. Optionally provide a `secret` (min 16 chars) — Pronesoft will sign webhook payloads with HMAC-SHA256 using this secret so you can verify authenticity on your end.
|
|
52
|
+
* Register new webhook
|
|
53
|
+
*/
|
|
54
|
+
createWebhook(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookConfigResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Creates request options for deleteWebhook without sending the request
|
|
57
|
+
* @param {string} rnc RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).
|
|
58
|
+
* @param {string} webhookId The unique ID of the webhook to delete.
|
|
59
|
+
* @throws {RequiredError}
|
|
60
|
+
* @memberof WebhookConfigurationApiInterface
|
|
61
|
+
*/
|
|
62
|
+
deleteWebhookRequestOpts(requestParameters: DeleteWebhookRequest): Promise<runtime.RequestOpts>;
|
|
63
|
+
/**
|
|
64
|
+
* Removes a registered webhook by its ID.
|
|
65
|
+
* @summary Delete webhook configuration
|
|
66
|
+
* @param {string} rnc RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).
|
|
67
|
+
* @param {string} webhookId The unique ID of the webhook to delete.
|
|
68
|
+
* @param {*} [options] Override http request option.
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
* @memberof WebhookConfigurationApiInterface
|
|
71
|
+
*/
|
|
72
|
+
deleteWebhookRaw(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
73
|
+
/**
|
|
74
|
+
* Removes a registered webhook by its ID.
|
|
75
|
+
* Delete webhook configuration
|
|
76
|
+
*/
|
|
77
|
+
deleteWebhook(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
78
|
+
/**
|
|
79
|
+
* Creates request options for listWebhooks without sending the request
|
|
80
|
+
* @param {string} rnc RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
* @memberof WebhookConfigurationApiInterface
|
|
83
|
+
*/
|
|
84
|
+
listWebhooksRequestOpts(requestParameters: ListWebhooksRequest): Promise<runtime.RequestOpts>;
|
|
85
|
+
/**
|
|
86
|
+
* Returns all registered webhooks for the given RNC.
|
|
87
|
+
* @summary List webhook configurations
|
|
88
|
+
* @param {string} rnc RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
* @memberof WebhookConfigurationApiInterface
|
|
92
|
+
*/
|
|
93
|
+
listWebhooksRaw(requestParameters: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WebhookConfigResponse>>>;
|
|
94
|
+
/**
|
|
95
|
+
* Returns all registered webhooks for the given RNC.
|
|
96
|
+
* List webhook configurations
|
|
97
|
+
*/
|
|
98
|
+
listWebhooks(requestParameters: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WebhookConfigResponse>>;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
export declare class WebhookConfigurationApi extends runtime.BaseAPI implements WebhookConfigurationApiInterface {
|
|
104
|
+
/**
|
|
105
|
+
* Creates request options for createWebhook without sending the request
|
|
106
|
+
*/
|
|
107
|
+
createWebhookRequestOpts(requestParameters: CreateWebhookRequest): Promise<runtime.RequestOpts>;
|
|
108
|
+
/**
|
|
109
|
+
* Registers a URL to receive real-time event notifications for the given RNC. You can subscribe to one or more `WebhookEventType` values. Optionally provide a `secret` (min 16 chars) — Pronesoft will sign webhook payloads with HMAC-SHA256 using this secret so you can verify authenticity on your end.
|
|
110
|
+
* Register new webhook
|
|
111
|
+
*/
|
|
112
|
+
createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookConfigResponse>>;
|
|
113
|
+
/**
|
|
114
|
+
* Registers a URL to receive real-time event notifications for the given RNC. You can subscribe to one or more `WebhookEventType` values. Optionally provide a `secret` (min 16 chars) — Pronesoft will sign webhook payloads with HMAC-SHA256 using this secret so you can verify authenticity on your end.
|
|
115
|
+
* Register new webhook
|
|
116
|
+
*/
|
|
117
|
+
createWebhook(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookConfigResponse>;
|
|
118
|
+
/**
|
|
119
|
+
* Creates request options for deleteWebhook without sending the request
|
|
120
|
+
*/
|
|
121
|
+
deleteWebhookRequestOpts(requestParameters: DeleteWebhookRequest): Promise<runtime.RequestOpts>;
|
|
122
|
+
/**
|
|
123
|
+
* Removes a registered webhook by its ID.
|
|
124
|
+
* Delete webhook configuration
|
|
125
|
+
*/
|
|
126
|
+
deleteWebhookRaw(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
127
|
+
/**
|
|
128
|
+
* Removes a registered webhook by its ID.
|
|
129
|
+
* Delete webhook configuration
|
|
130
|
+
*/
|
|
131
|
+
deleteWebhook(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
132
|
+
/**
|
|
133
|
+
* Creates request options for listWebhooks without sending the request
|
|
134
|
+
*/
|
|
135
|
+
listWebhooksRequestOpts(requestParameters: ListWebhooksRequest): Promise<runtime.RequestOpts>;
|
|
136
|
+
/**
|
|
137
|
+
* Returns all registered webhooks for the given RNC.
|
|
138
|
+
* List webhook configurations
|
|
139
|
+
*/
|
|
140
|
+
listWebhooksRaw(requestParameters: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WebhookConfigResponse>>>;
|
|
141
|
+
/**
|
|
142
|
+
* Returns all registered webhooks for the given RNC.
|
|
143
|
+
* List webhook configurations
|
|
144
|
+
*/
|
|
145
|
+
listWebhooks(requestParameters: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WebhookConfigResponse>>;
|
|
146
|
+
}
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* eCF-Pronesoft Integration API
|
|
6
|
+
* ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform, which handles all communication with the DGII on your behalf. ## Authentication — OAuth 2.0 Client Credentials This API uses the **OAuth 2.0 Client Credentials** flow. There is no user login — authentication is machine-to-machine using a `clientId` and `clientSecret` issued by the Pronesoft portal. ### Step-by-step 1. **Get credentials**: - Sandbox: https://ecf.sandbox.pronesoft.com - Production: https://ecf.pronesoft.com 2. **Request a token** — call `POST /oauth/token` with your credentials. The server returns an `accessToken` valid for `expiresIn` seconds. 3. **Authorize requests** — include the token in every subsequent request: ``` Authorization: Bearer <accessToken> ``` 4. **Identify your tenant** — include your company/branch UUID in every protected request: ``` x-tenant-id: <your-tenant-uuid> ``` 5. **Refresh** — when the token expires, simply call `POST /oauth/token` again. ### Scopes | Category | Scope | Description | |---|---|---| | **Business** | `business:read` | Read company data | | | `business:create` | Create a new company | | | `business:update` | Update company data | | **Members** | `members:read` | View team members | | | `members:invite` | Invite new members | | | `members:revoke` | Revoke member access | | **Certificates** | `certificates:read` | View digital certificates | | | `certificates:upload` | Upload new certificates | | | `certificates:update` | Update existing certificates | | **Documents** | `documents:read` | List and view documents | | | `documents:create` | Create drafts or internal documents | | | `documents:send` | Submit e-CF to DGII | | | `documents:receive` | Receive e-CF from third parties | | | `documents:update` | Modify document metadata | | **Approvals** | `approvals:read` | View approval statuses | | | `approvals:commercial` | Perform commercial approvals/rejections | | **Sequences** | `sequences:read` | View NCF/e-NCF ranges | | | `sequences:create` | Request new sequences | | | `sequences:update` | Modify sequence configurations | | | `sequences:cancel` | Cancel unused sequences | | **Dashboard** | `business_info:read` | Access dashboard stats and metrics | | **Certification** | `certification:read` | View certification progress | | | `certification:write` | Run automated DGII certification tests | | **Reports** | `reports:read` | Generate and export reports (e.g. 606) | ## Environments | Environment | Portal | API Host | Purpose | |---|---|---|---| | Sandbox | https://ecf.sandbox.pronesoft.com | `api.ecf.sandbox.pronesoft.com` | Development & testing | | Production | https://ecf.pronesoft.com | `api.ecf.pronesoft.com` | Live e-CF issuance | ## Invoice Types (e-NCF) | Code | Name | |---|---| | `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) |
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.0.1
|
|
9
|
+
* Contact: contacto@pronesoft.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.WebhookConfigurationApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const index_1 = require("../models/index");
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
class WebhookConfigurationApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Creates request options for createWebhook without sending the request
|
|
34
|
+
*/
|
|
35
|
+
createWebhookRequestOpts(requestParameters) {
|
|
36
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
37
|
+
if (requestParameters['rnc'] == null) {
|
|
38
|
+
throw new runtime.RequiredError('rnc', 'Required parameter "rnc" was null or undefined when calling createWebhook().');
|
|
39
|
+
}
|
|
40
|
+
if (requestParameters['createWebhookConfig'] == null) {
|
|
41
|
+
throw new runtime.RequiredError('createWebhookConfig', 'Required parameter "createWebhookConfig" was null or undefined when calling createWebhook().');
|
|
42
|
+
}
|
|
43
|
+
const queryParameters = {};
|
|
44
|
+
const headerParameters = {};
|
|
45
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
46
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
47
|
+
// oauth required
|
|
48
|
+
headerParameters["Authorization"] = yield this.configuration.accessToken("oauth2", ["business:update"]);
|
|
49
|
+
}
|
|
50
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
51
|
+
const token = this.configuration.accessToken;
|
|
52
|
+
const tokenString = yield token("bearerAuth", []);
|
|
53
|
+
if (tokenString) {
|
|
54
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
let urlPath = `/{rnc}/webhooks`;
|
|
58
|
+
urlPath = urlPath.replace(`{${"rnc"}}`, encodeURIComponent(String(requestParameters['rnc'])));
|
|
59
|
+
return {
|
|
60
|
+
path: urlPath,
|
|
61
|
+
method: 'POST',
|
|
62
|
+
headers: headerParameters,
|
|
63
|
+
query: queryParameters,
|
|
64
|
+
body: (0, index_1.CreateWebhookConfigToJSON)(requestParameters['createWebhookConfig']),
|
|
65
|
+
};
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Registers a URL to receive real-time event notifications for the given RNC. You can subscribe to one or more `WebhookEventType` values. Optionally provide a `secret` (min 16 chars) — Pronesoft will sign webhook payloads with HMAC-SHA256 using this secret so you can verify authenticity on your end.
|
|
70
|
+
* Register new webhook
|
|
71
|
+
*/
|
|
72
|
+
createWebhookRaw(requestParameters, initOverrides) {
|
|
73
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
74
|
+
const requestOptions = yield this.createWebhookRequestOpts(requestParameters);
|
|
75
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
76
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookConfigResponseFromJSON)(jsonValue));
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Registers a URL to receive real-time event notifications for the given RNC. You can subscribe to one or more `WebhookEventType` values. Optionally provide a `secret` (min 16 chars) — Pronesoft will sign webhook payloads with HMAC-SHA256 using this secret so you can verify authenticity on your end.
|
|
81
|
+
* Register new webhook
|
|
82
|
+
*/
|
|
83
|
+
createWebhook(requestParameters, initOverrides) {
|
|
84
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85
|
+
const response = yield this.createWebhookRaw(requestParameters, initOverrides);
|
|
86
|
+
return yield response.value();
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Creates request options for deleteWebhook without sending the request
|
|
91
|
+
*/
|
|
92
|
+
deleteWebhookRequestOpts(requestParameters) {
|
|
93
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
94
|
+
if (requestParameters['rnc'] == null) {
|
|
95
|
+
throw new runtime.RequiredError('rnc', 'Required parameter "rnc" was null or undefined when calling deleteWebhook().');
|
|
96
|
+
}
|
|
97
|
+
if (requestParameters['webhookId'] == null) {
|
|
98
|
+
throw new runtime.RequiredError('webhookId', 'Required parameter "webhookId" was null or undefined when calling deleteWebhook().');
|
|
99
|
+
}
|
|
100
|
+
const queryParameters = {};
|
|
101
|
+
const headerParameters = {};
|
|
102
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
103
|
+
// oauth required
|
|
104
|
+
headerParameters["Authorization"] = yield this.configuration.accessToken("oauth2", ["business:update"]);
|
|
105
|
+
}
|
|
106
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
107
|
+
const token = this.configuration.accessToken;
|
|
108
|
+
const tokenString = yield token("bearerAuth", []);
|
|
109
|
+
if (tokenString) {
|
|
110
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
let urlPath = `/{rnc}/webhooks/{webhookId}`;
|
|
114
|
+
urlPath = urlPath.replace(`{${"rnc"}}`, encodeURIComponent(String(requestParameters['rnc'])));
|
|
115
|
+
urlPath = urlPath.replace(`{${"webhookId"}}`, encodeURIComponent(String(requestParameters['webhookId'])));
|
|
116
|
+
return {
|
|
117
|
+
path: urlPath,
|
|
118
|
+
method: 'DELETE',
|
|
119
|
+
headers: headerParameters,
|
|
120
|
+
query: queryParameters,
|
|
121
|
+
};
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Removes a registered webhook by its ID.
|
|
126
|
+
* Delete webhook configuration
|
|
127
|
+
*/
|
|
128
|
+
deleteWebhookRaw(requestParameters, initOverrides) {
|
|
129
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
130
|
+
const requestOptions = yield this.deleteWebhookRequestOpts(requestParameters);
|
|
131
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
132
|
+
return new runtime.VoidApiResponse(response);
|
|
133
|
+
});
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Removes a registered webhook by its ID.
|
|
137
|
+
* Delete webhook configuration
|
|
138
|
+
*/
|
|
139
|
+
deleteWebhook(requestParameters, initOverrides) {
|
|
140
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
141
|
+
yield this.deleteWebhookRaw(requestParameters, initOverrides);
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Creates request options for listWebhooks without sending the request
|
|
146
|
+
*/
|
|
147
|
+
listWebhooksRequestOpts(requestParameters) {
|
|
148
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
149
|
+
if (requestParameters['rnc'] == null) {
|
|
150
|
+
throw new runtime.RequiredError('rnc', 'Required parameter "rnc" was null or undefined when calling listWebhooks().');
|
|
151
|
+
}
|
|
152
|
+
const queryParameters = {};
|
|
153
|
+
const headerParameters = {};
|
|
154
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
155
|
+
// oauth required
|
|
156
|
+
headerParameters["Authorization"] = yield this.configuration.accessToken("oauth2", ["business:read"]);
|
|
157
|
+
}
|
|
158
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
159
|
+
const token = this.configuration.accessToken;
|
|
160
|
+
const tokenString = yield token("bearerAuth", []);
|
|
161
|
+
if (tokenString) {
|
|
162
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
let urlPath = `/{rnc}/webhooks`;
|
|
166
|
+
urlPath = urlPath.replace(`{${"rnc"}}`, encodeURIComponent(String(requestParameters['rnc'])));
|
|
167
|
+
return {
|
|
168
|
+
path: urlPath,
|
|
169
|
+
method: 'GET',
|
|
170
|
+
headers: headerParameters,
|
|
171
|
+
query: queryParameters,
|
|
172
|
+
};
|
|
173
|
+
});
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Returns all registered webhooks for the given RNC.
|
|
177
|
+
* List webhook configurations
|
|
178
|
+
*/
|
|
179
|
+
listWebhooksRaw(requestParameters, initOverrides) {
|
|
180
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
181
|
+
const requestOptions = yield this.listWebhooksRequestOpts(requestParameters);
|
|
182
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
183
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.WebhookConfigResponseFromJSON));
|
|
184
|
+
});
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Returns all registered webhooks for the given RNC.
|
|
188
|
+
* List webhook configurations
|
|
189
|
+
*/
|
|
190
|
+
listWebhooks(requestParameters, initOverrides) {
|
|
191
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
192
|
+
const response = yield this.listWebhooksRaw(requestParameters, initOverrides);
|
|
193
|
+
return yield response.value();
|
|
194
|
+
});
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
exports.WebhookConfigurationApi = WebhookConfigurationApi;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
/* tslint:disable */
|
|
18
|
+
/* eslint-disable */
|
|
19
|
+
__exportStar(require("./AssociatedCompaniesApi"), exports);
|
|
20
|
+
__exportStar(require("./AuthenticationApi"), exports);
|
|
21
|
+
__exportStar(require("./DigitalCertificatesApi"), exports);
|
|
22
|
+
__exportStar(require("./ECFSubmissionApi"), exports);
|
|
23
|
+
__exportStar(require("./TaxSequencesApi"), exports);
|
|
24
|
+
__exportStar(require("./WebhookConfigurationApi"), exports);
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* eCF-Pronesoft Integration API
|
|
3
|
+
* ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform, which handles all communication with the DGII on your behalf. ## Authentication — OAuth 2.0 Client Credentials This API uses the **OAuth 2.0 Client Credentials** flow. There is no user login — authentication is machine-to-machine using a `clientId` and `clientSecret` issued by the Pronesoft portal. ### Step-by-step 1. **Get credentials**: - Sandbox: https://ecf.sandbox.pronesoft.com - Production: https://ecf.pronesoft.com 2. **Request a token** — call `POST /oauth/token` with your credentials. The server returns an `accessToken` valid for `expiresIn` seconds. 3. **Authorize requests** — include the token in every subsequent request: ``` Authorization: Bearer <accessToken> ``` 4. **Identify your tenant** — include your company/branch UUID in every protected request: ``` x-tenant-id: <your-tenant-uuid> ``` 5. **Refresh** — when the token expires, simply call `POST /oauth/token` again. ### Scopes | Category | Scope | Description | |---|---|---| | **Business** | `business:read` | Read company data | | | `business:create` | Create a new company | | | `business:update` | Update company data | | **Members** | `members:read` | View team members | | | `members:invite` | Invite new members | | | `members:revoke` | Revoke member access | | **Certificates** | `certificates:read` | View digital certificates | | | `certificates:upload` | Upload new certificates | | | `certificates:update` | Update existing certificates | | **Documents** | `documents:read` | List and view documents | | | `documents:create` | Create drafts or internal documents | | | `documents:send` | Submit e-CF to DGII | | | `documents:receive` | Receive e-CF from third parties | | | `documents:update` | Modify document metadata | | **Approvals** | `approvals:read` | View approval statuses | | | `approvals:commercial` | Perform commercial approvals/rejections | | **Sequences** | `sequences:read` | View NCF/e-NCF ranges | | | `sequences:create` | Request new sequences | | | `sequences:update` | Modify sequence configurations | | | `sequences:cancel` | Cancel unused sequences | | **Dashboard** | `business_info:read` | Access dashboard stats and metrics | | **Certification** | `certification:read` | View certification progress | | | `certification:write` | Run automated DGII certification tests | | **Reports** | `reports:read` | Generate and export reports (e.g. 606) | ## Environments | Environment | Portal | API Host | Purpose | |---|---|---|---| | Sandbox | https://ecf.sandbox.pronesoft.com | `api.ecf.sandbox.pronesoft.com` | Development & testing | | Production | https://ecf.pronesoft.com | `api.ecf.pronesoft.com` | Live e-CF issuance | ## Invoice Types (e-NCF) | Code | Name | |---|---| | `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) |
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.0.1
|
|
6
|
+
* Contact: contacto@pronesoft.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { AssociatedCompany, CreateAssociatedCompany201Response, PrintFormat } from '../models/index';
|
|
14
|
+
export interface CreateAssociatedCompanyRequest {
|
|
15
|
+
xTenantId: string;
|
|
16
|
+
email: string;
|
|
17
|
+
password: string;
|
|
18
|
+
name: string;
|
|
19
|
+
rnc: string;
|
|
20
|
+
phone: string;
|
|
21
|
+
address: string;
|
|
22
|
+
city: string;
|
|
23
|
+
country: string;
|
|
24
|
+
firstName?: string;
|
|
25
|
+
lastName?: string;
|
|
26
|
+
jobTitle?: string;
|
|
27
|
+
website?: string;
|
|
28
|
+
category?: string;
|
|
29
|
+
monthlySalesRange?: string;
|
|
30
|
+
printerType?: PrintFormat;
|
|
31
|
+
logo?: Blob;
|
|
32
|
+
}
|
|
33
|
+
export interface ListAssociatedCompaniesRequest {
|
|
34
|
+
xTenantId: string;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* AssociatedCompaniesApi - interface
|
|
38
|
+
*
|
|
39
|
+
* @export
|
|
40
|
+
* @interface AssociatedCompaniesApiInterface
|
|
41
|
+
*/
|
|
42
|
+
export interface AssociatedCompaniesApiInterface {
|
|
43
|
+
/**
|
|
44
|
+
* Creates request options for createAssociatedCompany without sending the request
|
|
45
|
+
* @param {string} xTenantId UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.
|
|
46
|
+
* @param {string} email Owner\\\'s email address (used for login).
|
|
47
|
+
* @param {string} password Initial password for the new account (min 8 characters).
|
|
48
|
+
* @param {string} name Legal business name.
|
|
49
|
+
* @param {string} rnc Company RNC (9 digits) or personal cedula (11 digits).
|
|
50
|
+
* @param {string} phone
|
|
51
|
+
* @param {string} address
|
|
52
|
+
* @param {string} city
|
|
53
|
+
* @param {string} country
|
|
54
|
+
* @param {string} [firstName]
|
|
55
|
+
* @param {string} [lastName]
|
|
56
|
+
* @param {string} [jobTitle]
|
|
57
|
+
* @param {string} [website]
|
|
58
|
+
* @param {string} [category] Business category or industry.
|
|
59
|
+
* @param {string} [monthlySalesRange] Estimated monthly sales range (e.g. \\\"0-500000\\\").
|
|
60
|
+
* @param {PrintFormat} [printerType]
|
|
61
|
+
* @param {Blob} [logo] Company logo image file (multipart upload).
|
|
62
|
+
* @throws {RequiredError}
|
|
63
|
+
* @memberof AssociatedCompaniesApiInterface
|
|
64
|
+
*/
|
|
65
|
+
createAssociatedCompanyRequestOpts(requestParameters: CreateAssociatedCompanyRequest): Promise<runtime.RequestOpts>;
|
|
66
|
+
/**
|
|
67
|
+
* Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
|
|
68
|
+
* @summary Create new associated company
|
|
69
|
+
* @param {string} xTenantId UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.
|
|
70
|
+
* @param {string} email Owner\\\'s email address (used for login).
|
|
71
|
+
* @param {string} password Initial password for the new account (min 8 characters).
|
|
72
|
+
* @param {string} name Legal business name.
|
|
73
|
+
* @param {string} rnc Company RNC (9 digits) or personal cedula (11 digits).
|
|
74
|
+
* @param {string} phone
|
|
75
|
+
* @param {string} address
|
|
76
|
+
* @param {string} city
|
|
77
|
+
* @param {string} country
|
|
78
|
+
* @param {string} [firstName]
|
|
79
|
+
* @param {string} [lastName]
|
|
80
|
+
* @param {string} [jobTitle]
|
|
81
|
+
* @param {string} [website]
|
|
82
|
+
* @param {string} [category] Business category or industry.
|
|
83
|
+
* @param {string} [monthlySalesRange] Estimated monthly sales range (e.g. \\\"0-500000\\\").
|
|
84
|
+
* @param {PrintFormat} [printerType]
|
|
85
|
+
* @param {Blob} [logo] Company logo image file (multipart upload).
|
|
86
|
+
* @param {*} [options] Override http request option.
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
* @memberof AssociatedCompaniesApiInterface
|
|
89
|
+
*/
|
|
90
|
+
createAssociatedCompanyRaw(requestParameters: CreateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAssociatedCompany201Response>>;
|
|
91
|
+
/**
|
|
92
|
+
* Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
|
|
93
|
+
* Create new associated company
|
|
94
|
+
*/
|
|
95
|
+
createAssociatedCompany(requestParameters: CreateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAssociatedCompany201Response>;
|
|
96
|
+
/**
|
|
97
|
+
* Creates request options for listAssociatedCompanies without sending the request
|
|
98
|
+
* @param {string} xTenantId UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
* @memberof AssociatedCompaniesApiInterface
|
|
101
|
+
*/
|
|
102
|
+
listAssociatedCompaniesRequestOpts(requestParameters: ListAssociatedCompaniesRequest): Promise<runtime.RequestOpts>;
|
|
103
|
+
/**
|
|
104
|
+
* Returns all companies and branches linked to the current tenant.
|
|
105
|
+
* @summary List associated companies / branches
|
|
106
|
+
* @param {string} xTenantId UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
* @memberof AssociatedCompaniesApiInterface
|
|
110
|
+
*/
|
|
111
|
+
listAssociatedCompaniesRaw(requestParameters: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AssociatedCompany>>>;
|
|
112
|
+
/**
|
|
113
|
+
* Returns all companies and branches linked to the current tenant.
|
|
114
|
+
* List associated companies / branches
|
|
115
|
+
*/
|
|
116
|
+
listAssociatedCompanies(requestParameters: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AssociatedCompany>>;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
*/
|
|
121
|
+
export declare class AssociatedCompaniesApi extends runtime.BaseAPI implements AssociatedCompaniesApiInterface {
|
|
122
|
+
/**
|
|
123
|
+
* Creates request options for createAssociatedCompany without sending the request
|
|
124
|
+
*/
|
|
125
|
+
createAssociatedCompanyRequestOpts(requestParameters: CreateAssociatedCompanyRequest): Promise<runtime.RequestOpts>;
|
|
126
|
+
/**
|
|
127
|
+
* Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
|
|
128
|
+
* Create new associated company
|
|
129
|
+
*/
|
|
130
|
+
createAssociatedCompanyRaw(requestParameters: CreateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAssociatedCompany201Response>>;
|
|
131
|
+
/**
|
|
132
|
+
* Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
|
|
133
|
+
* Create new associated company
|
|
134
|
+
*/
|
|
135
|
+
createAssociatedCompany(requestParameters: CreateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAssociatedCompany201Response>;
|
|
136
|
+
/**
|
|
137
|
+
* Creates request options for listAssociatedCompanies without sending the request
|
|
138
|
+
*/
|
|
139
|
+
listAssociatedCompaniesRequestOpts(requestParameters: ListAssociatedCompaniesRequest): Promise<runtime.RequestOpts>;
|
|
140
|
+
/**
|
|
141
|
+
* Returns all companies and branches linked to the current tenant.
|
|
142
|
+
* List associated companies / branches
|
|
143
|
+
*/
|
|
144
|
+
listAssociatedCompaniesRaw(requestParameters: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AssociatedCompany>>>;
|
|
145
|
+
/**
|
|
146
|
+
* Returns all companies and branches linked to the current tenant.
|
|
147
|
+
* List associated companies / branches
|
|
148
|
+
*/
|
|
149
|
+
listAssociatedCompanies(requestParameters: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AssociatedCompany>>;
|
|
150
|
+
}
|