@pronesoft-rd/ecf-sdk

v0.0.7

Published

a month ago

OpenAPI client for @pronesoft-rd/ecf-sdk

0High
0Medium
0Low

pronesoft

@pronesoft-rd/[email protected]

A TypeScript SDK client for the api.ecf.sandbox.pronesoft.com API.

Installation

npm install @pronesoft-rd/ecf-sdk

Recommended usage

This SDK includes an IntegrationClient that manages:

OAuth token acquisition
token cache
automatic refresh on 401

The recommended pattern is:

Create one IntegrationClient for the app or integration.
When the ERP user logs in, resolve the active tenant.
Create a tenant session with startSession(tenantId).
Reuse session.getClient() while that tenant stays active.

import { Environment, IntegrationClient } from "@pronesoft-rd/ecf-sdk";

const integrationClient = new IntegrationClient({
  baseUrl: "https://ecf.sandbox.pronesoft.com",
  clientId: process.env.PRONESOFT_CLIENT_ID!,
  clientSecret: process.env.PRONESOFT_CLIENT_SECRET!,
});

const session = integrationClient.startSession("130862346");
const client = session.getClient();

const response = await client.ecfSubmission.submitEcf({
  environment: Environment.TesteCF,
  electronicDocument: payload,
});

If the user changes company during the ERP session:

session.setCurrentTenant("101234567");
const client = session.getClient();

If you want to work without a session wrapper, you can also create a tenant-scoped client directly:

const client = integrationClient.forTenant("130862346");

Documentation

API Endpoints

All URIs are relative to https://api.ecf.sandbox.pronesoft.com/api/v1

| Class | --------------------------- | AssociatedCompaniesApi | AssociatedCompaniesApi | AssociatedCompaniesApi | AssociatedCompaniesApi | AssociatedCompaniesApi | AssociatedCompaniesApi | AuthenticationApi | AutomatedCertificationApi | AutomatedCertificationApi | AutomatedCertificationApi | AutomatedCertificationApi | CommercialApprovalsApi | DigitalCertificatesApi | DocumentsReceivedApi | DocumentsReceivedApi | DocumentsSentApi | DocumentsSentApi | DocumentsSentApi | DocumentsSentApi | ECFSubmissionApi | ECFSubmissionApi | ECFSubmissionApi | ECFSubmissionApi | ReportsApi | ReportsApi | TaxSequencesApi | TaxSequencesApi | TaxSequencesApi | TaxSequencesApi | TaxSequencesApi | WebhookConfigurationApi | WebhookConfigurationApi | WebhookConfigurationApi | Method | HTTP request | Description | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------ | | createAssociatedCompany | POST /associated-companies | Create associated company / branch | | deleteAssociatedCompany | DELETE /associated-companies/{companyId} | Delete associated company | | getCompanyDocumentMetrics | GET /associated-companies/{companyId}/documents-metrics | Get company document metrics | | getCompanyMetrics | GET /associated-companies/{companyId}/metrics | Get company metrics | | listAssociatedCompanies | GET /associated-companies | List associated companies / branches | | updateAssociatedCompany | PUT /associated-companies/{companyId} | Update associated company | | getAccessToken | POST /oauth/token | Get access token (OAuth 2.0) | | downloadCertification | GET /dgii-ecf/automated-certification/{id}/download | Download certification ZIP | | getCertificationStatus | GET /dgii-ecf/automated-certification/{id}/status | Get certification process status | | listCertificationNiches | GET /dgii-ecf/automated-certification/niches | List certification niches | | startCertification | POST /dgii-ecf/automated-certification/start | Start certification process | | listApprovals | GET /documents/approvals/all | List commercial approvals | | uploadCertificate | POST /{rnc}/certificates | Upload digital certificate (P12/PFX) | | getReceivedDocumentStats | GET /documents/received/stats/summary | Get received documents statistics | | listReceivedDocuments | GET /documents/received/all | List received documents | | downloadDocument | GET /documents/download | Download document XML | | getDocument | GET /documents/{id} | Get document details | | getDocumentStats | GET /documents/stats/summary | Get document statistics | | listSentDocuments | GET /documents/sent | List sent documents | | getEcfHistory | GET /{environment}/ecf/responses/history | Get submission history (last 50 documents) | | getEcfStats | GET /{environment}/ecf/responses/stats | Get submission statistics (last 30 days) | | getEcfStatus | GET /{environment}/ecf/status/{trackId} | Get document status by trackId | | submitEcf | POST /{environment}/ecf/submit | Submit e-CF document to DGII | | export606 | GET /dgii/606/export | Export Format 606 (Purchases) | | exportSentDocuments | GET /dgii/sent/export | Export sent documents report | | createTaxSequence | POST /tax-sequences/create | Create new tax sequence | | getNextNumber | GET /tax-sequences/next | Get next available fiscal number | | listTaxSequences | GET /tax-sequences | List tax sequences | | updateTaxSequence | PATCH /tax-sequences/update | Update tax sequence | | voidTaxSequence | POST /tax-sequences/void | Void a range of fiscal numbers | | getWebhook | GET /{rnc}/webhooks/{webhookId} | Get webhook details | | getWebhookStats | GET /{rnc}/webhooks/{webhookId}/stats | Get webhook delivery statistics | | listWebhooks | GET /{rnc}/webhooks | List webhook configurations |

Models

Authorization

Authentication schemes defined for the API:

bearerAuth

Type: HTTP Bearer Token authentication (JWT)

oauth2 application

Type: OAuth
Flow: application
Authorization URL:
Scopes:
- business:read: Read company data.
- business:create: Create a new company.
- business:update: Update company data.
- members:read: View team members.
- members:invite: Invite new members.
- members:revoke: Revoke member access.
- certificates:read: View digital certificates.
- certificates:upload: Upload new certificates.
- certificates:update: Update existing certificates.
- documents:read: List and view document details.
- documents:create: Create drafts or internal documents.
- documents:send: Submit e-CF to the DGII.
- documents:receive: Receive e-CF from third parties.
- documents:update: Modify document metadata.
- approvals:read: View approval statuses.
- approvals:commercial: Perform commercial approvals or rejections.
- sequences:read: View NCF/e-NCF ranges.
- sequences:create: Request or add new sequences.
- sequences:update: Modify sequence configurations.
- sequences:cancel: Cancel unused sequences.
- business_info:read: Access dashboard statistics and metrics.
- certification:read: View DGII certification progress.
- certification:write: Execute automated DGII certification tests.
- reports:read: Generate and export reports (e.g. format 606).

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 1.2.0
Package version: 0.0.6
Generator version: 7.21.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

For more information, please visit https://pronesoft.com

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Proprietary