@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.2
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 +104 -2
- package/README.md +90 -24
- package/dist/apis/AssociatedCompaniesApi.d.ts +195 -40
- package/dist/apis/AssociatedCompaniesApi.js +252 -23
- package/dist/apis/AuthenticationApi.d.ts +11 -11
- package/dist/apis/AuthenticationApi.js +7 -7
- package/dist/apis/AutomatedCertificationApi.d.ts +164 -0
- package/dist/apis/AutomatedCertificationApi.js +232 -0
- package/dist/apis/CommercialApprovalsApi.d.ts +120 -0
- package/dist/apis/CommercialApprovalsApi.js +141 -0
- package/dist/apis/DigitalCertificatesApi.d.ts +17 -17
- package/dist/apis/DigitalCertificatesApi.js +7 -7
- package/dist/apis/DocumentsReceivedApi.d.ts +117 -0
- package/dist/apis/DocumentsReceivedApi.js +152 -0
- package/dist/apis/DocumentsSentApi.d.ts +216 -0
- package/dist/apis/DocumentsSentApi.js +286 -0
- package/dist/apis/ECFSubmissionApi.d.ts +130 -13
- package/dist/apis/ECFSubmissionApi.js +168 -8
- package/dist/apis/ReportsApi.d.ts +143 -0
- package/dist/apis/ReportsApi.js +193 -0
- package/dist/apis/TaxSequencesApi.d.ts +120 -38
- package/dist/apis/TaxSequencesApi.js +129 -22
- package/dist/apis/WebhookConfigurationApi.d.ts +60 -53
- package/dist/apis/WebhookConfigurationApi.js +49 -41
- package/dist/apis/index.d.ts +5 -0
- package/dist/apis/index.js +5 -0
- package/dist/esm/apis/AssociatedCompaniesApi.d.ts +195 -40
- package/dist/esm/apis/AssociatedCompaniesApi.js +253 -24
- package/dist/esm/apis/AuthenticationApi.d.ts +11 -11
- package/dist/esm/apis/AuthenticationApi.js +7 -7
- package/dist/esm/apis/AutomatedCertificationApi.d.ts +164 -0
- package/dist/esm/apis/AutomatedCertificationApi.js +228 -0
- package/dist/esm/apis/CommercialApprovalsApi.d.ts +120 -0
- package/dist/esm/apis/CommercialApprovalsApi.js +137 -0
- package/dist/esm/apis/DigitalCertificatesApi.d.ts +17 -17
- package/dist/esm/apis/DigitalCertificatesApi.js +7 -7
- package/dist/esm/apis/DocumentsReceivedApi.d.ts +117 -0
- package/dist/esm/apis/DocumentsReceivedApi.js +148 -0
- package/dist/esm/apis/DocumentsSentApi.d.ts +216 -0
- package/dist/esm/apis/DocumentsSentApi.js +282 -0
- package/dist/esm/apis/ECFSubmissionApi.d.ts +130 -13
- package/dist/esm/apis/ECFSubmissionApi.js +169 -9
- package/dist/esm/apis/ReportsApi.d.ts +143 -0
- package/dist/esm/apis/ReportsApi.js +189 -0
- package/dist/esm/apis/TaxSequencesApi.d.ts +120 -38
- package/dist/esm/apis/TaxSequencesApi.js +130 -23
- package/dist/esm/apis/WebhookConfigurationApi.d.ts +60 -53
- package/dist/esm/apis/WebhookConfigurationApi.js +49 -41
- package/dist/esm/apis/index.d.ts +5 -0
- package/dist/esm/apis/index.js +5 -0
- package/dist/esm/models/AccountType.d.ts +4 -8
- package/dist/esm/models/AccountType.js +4 -8
- package/dist/esm/models/AdditionalInfo.d.ts +60 -12
- package/dist/esm/models/AdditionalInfo.js +23 -7
- package/dist/esm/models/AlternativeCurrency.d.ts +78 -8
- package/dist/esm/models/AlternativeCurrency.js +27 -3
- package/dist/esm/models/ApprovalItem.d.ts +74 -0
- package/dist/esm/models/ApprovalItem.js +55 -0
- package/dist/esm/models/ApprovalListResponse.d.ts +40 -0
- package/dist/esm/models/ApprovalListResponse.js +45 -0
- package/dist/esm/models/AssociatedCompany.d.ts +33 -14
- package/dist/esm/models/AssociatedCompany.js +18 -11
- package/dist/esm/models/AssociatedCompanySubscription.d.ts +5 -5
- package/dist/esm/models/AssociatedCompanySubscription.js +3 -3
- package/dist/esm/models/AssociatedCompanySubscriptionPlan.d.ts +4 -4
- package/dist/esm/models/AssociatedCompanySubscriptionPlan.js +3 -3
- package/dist/esm/models/BillingIndicator.d.ts +4 -10
- package/dist/esm/models/BillingIndicator.js +4 -10
- package/dist/esm/models/Buyer.d.ts +71 -11
- package/dist/esm/models/Buyer.js +23 -3
- package/dist/esm/models/CertificationNiche.d.ts +51 -0
- package/dist/esm/models/CertificationNiche.js +48 -0
- package/dist/esm/models/CertificationNicheNicheItemsInner.d.ts +38 -0
- package/dist/esm/models/CertificationNicheNicheItemsInner.js +43 -0
- package/dist/esm/models/CertificationStatus.d.ts +54 -0
- package/dist/esm/models/CertificationStatus.js +54 -0
- package/dist/esm/models/CompanyDocumentMetrics.d.ts +53 -0
- package/dist/esm/models/CompanyDocumentMetrics.js +50 -0
- package/dist/esm/models/CompanyDocumentMetricsGroupByStatusInner.d.ts +39 -0
- package/dist/esm/models/CompanyDocumentMetricsGroupByStatusInner.js +44 -0
- package/dist/esm/models/CompanyDocumentMetricsGroupByStatusInnerCount.d.ts +32 -0
- package/dist/esm/models/CompanyDocumentMetricsGroupByStatusInnerCount.js +41 -0
- package/dist/esm/models/CompanyDocumentMetricsMainBusiness.d.ts +44 -0
- package/dist/esm/models/CompanyDocumentMetricsMainBusiness.js +45 -0
- package/dist/esm/models/CompanyDocumentMetricsTotals.d.ts +38 -0
- package/dist/esm/models/CompanyDocumentMetricsTotals.js +43 -0
- package/dist/esm/models/CompanyMetrics.d.ts +81 -0
- package/dist/esm/models/CompanyMetrics.js +58 -0
- package/dist/esm/models/CompanyMetricsDocumentsStatus.d.ts +44 -0
- package/dist/esm/models/CompanyMetricsDocumentsStatus.js +45 -0
- package/dist/esm/models/CreateAssociatedCompany201Response.d.ts +3 -3
- package/dist/esm/models/CreateAssociatedCompany201Response.js +3 -3
- package/dist/esm/models/CreateTaxSequence201Response.d.ts +39 -0
- package/dist/esm/models/CreateTaxSequence201Response.js +44 -0
- package/dist/esm/models/CreateTaxSequenceRequest.d.ts +27 -10
- package/dist/esm/models/CreateTaxSequenceRequest.js +13 -6
- package/dist/esm/models/DeleteAssociatedCompany200Response.d.ts +32 -0
- package/dist/esm/models/DeleteAssociatedCompany200Response.js +41 -0
- package/dist/esm/models/DiscountOrSurcharge.d.ts +31 -19
- package/dist/esm/models/DiscountOrSurcharge.js +16 -7
- package/dist/esm/models/DocumentStatsResponse.d.ts +54 -0
- package/dist/esm/models/DocumentStatsResponse.js +47 -0
- package/dist/esm/models/DocumentStatus.d.ts +28 -0
- package/dist/esm/models/DocumentStatus.js +46 -0
- package/dist/esm/models/EcfHistoryItem.d.ts +83 -0
- package/dist/esm/models/EcfHistoryItem.js +60 -0
- package/dist/esm/models/EcfStatsResponse.d.ts +80 -0
- package/dist/esm/models/EcfStatsResponse.js +57 -0
- package/dist/esm/models/EcfStatusResponse.d.ts +110 -0
- package/dist/esm/models/EcfStatusResponse.js +74 -0
- package/dist/esm/models/EcfStatusResponseMensajesInner.d.ts +38 -0
- package/dist/esm/models/EcfStatusResponseMensajesInner.js +43 -0
- package/dist/esm/models/EcfSubmissionResponse.d.ts +68 -11
- package/dist/esm/models/EcfSubmissionResponse.js +25 -8
- package/dist/esm/models/EcfSubmissionResponseDgiiResponse.d.ts +50 -0
- package/dist/esm/models/EcfSubmissionResponseDgiiResponse.js +47 -0
- package/dist/esm/models/ElectronicDocument.d.ts +166 -64
- package/dist/esm/models/ElectronicDocument.js +66 -22
- package/dist/esm/models/Environment.d.ts +4 -8
- package/dist/esm/models/Environment.js +4 -8
- package/dist/esm/models/ErrorResponse.d.ts +13 -7
- package/dist/esm/models/ErrorResponse.js +5 -3
- package/dist/esm/models/GetNextNumber200Response.d.ts +3 -3
- package/dist/esm/models/GetNextNumber200Response.js +3 -3
- package/dist/esm/models/GetNextNumber200ResponseData.d.ts +11 -5
- package/dist/esm/models/GetNextNumber200ResponseData.js +5 -3
- package/dist/esm/models/InvoiceType.d.ts +6 -14
- package/dist/esm/models/InvoiceType.js +6 -14
- package/dist/esm/models/InvoiceTypeSequence.d.ts +33 -0
- package/dist/esm/models/InvoiceTypeSequence.js +51 -0
- package/dist/esm/models/Item.d.ts +118 -21
- package/dist/esm/models/Item.js +45 -9
- package/dist/esm/models/ItemAdditionalTax.d.ts +7 -7
- package/dist/esm/models/ItemAdditionalTax.js +4 -6
- package/dist/esm/models/ItemAlternativeCurrency.d.ts +50 -0
- package/dist/esm/models/ItemAlternativeCurrency.js +47 -0
- package/dist/esm/models/ItemCodesInner.d.ts +38 -0
- package/dist/esm/models/ItemCodesInner.js +43 -0
- package/dist/esm/models/ItemDiscountInner.d.ts +44 -0
- package/dist/esm/models/ItemDiscountInner.js +45 -0
- package/dist/esm/models/ItemMiningInfo.d.ts +50 -0
- package/dist/esm/models/ItemMiningInfo.js +47 -0
- package/dist/esm/models/ListTaxSequences200Response.d.ts +10 -3
- package/dist/esm/models/ListTaxSequences200Response.js +6 -3
- package/dist/esm/models/OAuthTokenRequest.d.ts +6 -11
- package/dist/esm/models/OAuthTokenRequest.js +3 -3
- package/dist/esm/models/OAuthTokenResponse.d.ts +7 -9
- package/dist/esm/models/OAuthTokenResponse.js +3 -3
- package/dist/esm/models/Page.d.ts +15 -15
- package/dist/esm/models/Page.js +10 -16
- package/dist/esm/models/PaginationMeta.d.ts +50 -0
- package/dist/esm/models/PaginationMeta.js +47 -0
- package/dist/esm/models/PaymentForm.d.ts +39 -0
- package/dist/esm/models/PaymentForm.js +48 -0
- package/dist/esm/models/PaymentMethod.d.ts +4 -13
- package/dist/esm/models/PaymentMethod.js +4 -13
- package/dist/esm/models/PrintFormat.d.ts +3 -7
- package/dist/esm/models/PrintFormat.js +3 -7
- package/dist/esm/models/ProcessingLog.d.ts +54 -0
- package/dist/esm/models/ProcessingLog.js +54 -0
- package/dist/esm/models/RateLimitErrorResponse.d.ts +50 -0
- package/dist/esm/models/RateLimitErrorResponse.js +47 -0
- package/dist/esm/models/ReceivedDocument.d.ts +81 -0
- package/dist/esm/models/ReceivedDocument.js +58 -0
- package/dist/esm/models/ReceivedDocumentListResponse.d.ts +46 -0
- package/dist/esm/models/ReceivedDocumentListResponse.js +47 -0
- package/dist/esm/models/ReceivedDocumentStatsResponse.d.ts +46 -0
- package/dist/esm/models/ReceivedDocumentStatsResponse.js +45 -0
- package/dist/esm/models/ReferenceInfo.d.ts +9 -18
- package/dist/esm/models/ReferenceInfo.js +4 -4
- package/dist/esm/models/SentDocumentDetail.d.ts +107 -0
- package/dist/esm/models/SentDocumentDetail.js +68 -0
- package/dist/esm/models/SentDocumentListResponse.d.ts +46 -0
- package/dist/esm/models/SentDocumentListResponse.js +47 -0
- package/dist/esm/models/SentDocumentSummary.d.ts +94 -0
- package/dist/esm/models/SentDocumentSummary.js +63 -0
- package/dist/esm/models/SentDocumentSummaryBusiness.d.ts +38 -0
- package/dist/esm/models/SentDocumentSummaryBusiness.js +43 -0
- package/dist/esm/models/StartCertification200Response.d.ts +32 -0
- package/dist/esm/models/StartCertification200Response.js +41 -0
- package/dist/esm/models/StartCertificationRequest.d.ts +51 -0
- package/dist/esm/models/StartCertificationRequest.js +54 -0
- package/dist/esm/models/Subquantity.d.ts +6 -6
- package/dist/esm/models/Subquantity.js +3 -3
- package/dist/esm/models/Subtotal.d.ts +18 -12
- package/dist/esm/models/Subtotal.js +8 -10
- package/dist/esm/models/TaxSequence.d.ts +68 -10
- package/dist/esm/models/TaxSequence.js +33 -8
- package/dist/esm/models/TaxSequenceCreated.d.ts +64 -0
- package/dist/esm/models/TaxSequenceCreated.js +53 -0
- package/dist/esm/models/Totals.d.ts +29 -32
- package/dist/esm/models/Totals.js +5 -6
- package/dist/esm/models/Transport.d.ts +26 -14
- package/dist/esm/models/Transport.js +11 -7
- package/dist/esm/models/UpdateTaxSequenceRequest.d.ts +64 -0
- package/dist/esm/models/UpdateTaxSequenceRequest.js +53 -0
- package/dist/esm/models/UploadCertificateResponse.d.ts +7 -7
- package/dist/esm/models/UploadCertificateResponse.js +3 -3
- package/dist/esm/models/VoidTaxSequence200Response.d.ts +39 -0
- package/dist/esm/models/VoidTaxSequence200Response.js +44 -0
- package/dist/esm/models/VoidTaxSequence200ResponseData.d.ts +44 -0
- package/dist/esm/models/VoidTaxSequence200ResponseData.js +45 -0
- package/dist/esm/models/VoidTaxSequenceRequest.d.ts +50 -0
- package/dist/esm/models/VoidTaxSequenceRequest.js +55 -0
- package/dist/esm/models/WebhookConfigDetail.d.ts +81 -0
- package/dist/esm/models/WebhookConfigDetail.js +58 -0
- package/dist/esm/models/WebhookConfigResponse.d.ts +21 -9
- package/dist/esm/models/WebhookConfigResponse.js +7 -3
- package/dist/esm/models/WebhookEventType.d.ts +9 -8
- package/dist/esm/models/WebhookEventType.js +9 -8
- package/dist/esm/models/WebhookNotificationPayload.d.ts +10 -9
- package/dist/esm/models/WebhookNotificationPayload.js +3 -3
- package/dist/esm/models/WebhookStats.d.ts +45 -0
- package/dist/esm/models/WebhookStats.js +46 -0
- package/dist/esm/models/WebhookStatsStats.d.ts +62 -0
- package/dist/esm/models/WebhookStatsStats.js +51 -0
- package/dist/esm/models/index.d.ts +47 -1
- package/dist/esm/models/index.js +47 -1
- package/dist/esm/runtime.d.ts +3 -3
- package/dist/esm/runtime.js +3 -3
- package/dist/models/AccountType.d.ts +4 -8
- package/dist/models/AccountType.js +4 -8
- package/dist/models/AdditionalInfo.d.ts +60 -12
- package/dist/models/AdditionalInfo.js +23 -7
- package/dist/models/AlternativeCurrency.d.ts +78 -8
- package/dist/models/AlternativeCurrency.js +27 -3
- package/dist/models/ApprovalItem.d.ts +74 -0
- package/dist/models/ApprovalItem.js +62 -0
- package/dist/models/ApprovalListResponse.d.ts +40 -0
- package/dist/models/ApprovalListResponse.js +52 -0
- package/dist/models/AssociatedCompany.d.ts +33 -14
- package/dist/models/AssociatedCompany.js +18 -11
- package/dist/models/AssociatedCompanySubscription.d.ts +5 -5
- package/dist/models/AssociatedCompanySubscription.js +3 -3
- package/dist/models/AssociatedCompanySubscriptionPlan.d.ts +4 -4
- package/dist/models/AssociatedCompanySubscriptionPlan.js +3 -3
- package/dist/models/BillingIndicator.d.ts +4 -10
- package/dist/models/BillingIndicator.js +4 -10
- package/dist/models/Buyer.d.ts +71 -11
- package/dist/models/Buyer.js +23 -3
- package/dist/models/CertificationNiche.d.ts +51 -0
- package/dist/models/CertificationNiche.js +55 -0
- package/dist/models/CertificationNicheNicheItemsInner.d.ts +38 -0
- package/dist/models/CertificationNicheNicheItemsInner.js +50 -0
- package/dist/models/CertificationStatus.d.ts +54 -0
- package/dist/models/CertificationStatus.js +62 -0
- package/dist/models/CompanyDocumentMetrics.d.ts +53 -0
- package/dist/models/CompanyDocumentMetrics.js +57 -0
- package/dist/models/CompanyDocumentMetricsGroupByStatusInner.d.ts +39 -0
- package/dist/models/CompanyDocumentMetricsGroupByStatusInner.js +51 -0
- package/dist/models/CompanyDocumentMetricsGroupByStatusInnerCount.d.ts +32 -0
- package/dist/models/CompanyDocumentMetricsGroupByStatusInnerCount.js +48 -0
- package/dist/models/CompanyDocumentMetricsMainBusiness.d.ts +44 -0
- package/dist/models/CompanyDocumentMetricsMainBusiness.js +52 -0
- package/dist/models/CompanyDocumentMetricsTotals.d.ts +38 -0
- package/dist/models/CompanyDocumentMetricsTotals.js +50 -0
- package/dist/models/CompanyMetrics.d.ts +81 -0
- package/dist/models/CompanyMetrics.js +65 -0
- package/dist/models/CompanyMetricsDocumentsStatus.d.ts +44 -0
- package/dist/models/CompanyMetricsDocumentsStatus.js +52 -0
- package/dist/models/CreateAssociatedCompany201Response.d.ts +3 -3
- package/dist/models/CreateAssociatedCompany201Response.js +3 -3
- package/dist/models/CreateTaxSequence201Response.d.ts +39 -0
- package/dist/models/CreateTaxSequence201Response.js +51 -0
- package/dist/models/CreateTaxSequenceRequest.d.ts +27 -10
- package/dist/models/CreateTaxSequenceRequest.js +13 -6
- package/dist/models/DeleteAssociatedCompany200Response.d.ts +32 -0
- package/dist/models/DeleteAssociatedCompany200Response.js +48 -0
- package/dist/models/DiscountOrSurcharge.d.ts +31 -19
- package/dist/models/DiscountOrSurcharge.js +17 -8
- package/dist/models/DocumentStatsResponse.d.ts +54 -0
- package/dist/models/DocumentStatsResponse.js +54 -0
- package/dist/models/DocumentStatus.d.ts +28 -0
- package/dist/models/DocumentStatus.js +54 -0
- package/dist/models/EcfHistoryItem.d.ts +83 -0
- package/dist/models/EcfHistoryItem.js +67 -0
- package/dist/models/EcfStatsResponse.d.ts +80 -0
- package/dist/models/EcfStatsResponse.js +64 -0
- package/dist/models/EcfStatusResponse.d.ts +110 -0
- package/dist/models/EcfStatusResponse.js +82 -0
- package/dist/models/EcfStatusResponseMensajesInner.d.ts +38 -0
- package/dist/models/EcfStatusResponseMensajesInner.js +50 -0
- package/dist/models/EcfSubmissionResponse.d.ts +68 -11
- package/dist/models/EcfSubmissionResponse.js +25 -8
- package/dist/models/EcfSubmissionResponseDgiiResponse.d.ts +50 -0
- package/dist/models/EcfSubmissionResponseDgiiResponse.js +54 -0
- package/dist/models/ElectronicDocument.d.ts +166 -64
- package/dist/models/ElectronicDocument.js +67 -23
- package/dist/models/Environment.d.ts +4 -8
- package/dist/models/Environment.js +4 -8
- package/dist/models/ErrorResponse.d.ts +13 -7
- package/dist/models/ErrorResponse.js +5 -3
- package/dist/models/GetNextNumber200Response.d.ts +3 -3
- package/dist/models/GetNextNumber200Response.js +3 -3
- package/dist/models/GetNextNumber200ResponseData.d.ts +11 -5
- package/dist/models/GetNextNumber200ResponseData.js +5 -3
- package/dist/models/InvoiceType.d.ts +6 -14
- package/dist/models/InvoiceType.js +6 -14
- package/dist/models/InvoiceTypeSequence.d.ts +33 -0
- package/dist/models/InvoiceTypeSequence.js +59 -0
- package/dist/models/Item.d.ts +118 -21
- package/dist/models/Item.js +45 -9
- package/dist/models/ItemAdditionalTax.d.ts +7 -7
- package/dist/models/ItemAdditionalTax.js +4 -6
- package/dist/models/ItemAlternativeCurrency.d.ts +50 -0
- package/dist/models/ItemAlternativeCurrency.js +54 -0
- package/dist/models/ItemCodesInner.d.ts +38 -0
- package/dist/models/ItemCodesInner.js +50 -0
- package/dist/models/ItemDiscountInner.d.ts +44 -0
- package/dist/models/ItemDiscountInner.js +52 -0
- package/dist/models/ItemMiningInfo.d.ts +50 -0
- package/dist/models/ItemMiningInfo.js +54 -0
- package/dist/models/ListTaxSequences200Response.d.ts +10 -3
- package/dist/models/ListTaxSequences200Response.js +6 -3
- package/dist/models/OAuthTokenRequest.d.ts +6 -11
- package/dist/models/OAuthTokenRequest.js +3 -3
- package/dist/models/OAuthTokenResponse.d.ts +7 -9
- package/dist/models/OAuthTokenResponse.js +3 -3
- package/dist/models/Page.d.ts +15 -15
- package/dist/models/Page.js +10 -16
- package/dist/models/PaginationMeta.d.ts +50 -0
- package/dist/models/PaginationMeta.js +54 -0
- package/dist/models/PaymentForm.d.ts +39 -0
- package/dist/models/PaymentForm.js +55 -0
- package/dist/models/PaymentMethod.d.ts +4 -13
- package/dist/models/PaymentMethod.js +4 -13
- package/dist/models/PrintFormat.d.ts +3 -7
- package/dist/models/PrintFormat.js +3 -7
- package/dist/models/ProcessingLog.d.ts +54 -0
- package/dist/models/ProcessingLog.js +62 -0
- package/dist/models/RateLimitErrorResponse.d.ts +50 -0
- package/dist/models/RateLimitErrorResponse.js +54 -0
- package/dist/models/ReceivedDocument.d.ts +81 -0
- package/dist/models/ReceivedDocument.js +65 -0
- package/dist/models/ReceivedDocumentListResponse.d.ts +46 -0
- package/dist/models/ReceivedDocumentListResponse.js +54 -0
- package/dist/models/ReceivedDocumentStatsResponse.d.ts +46 -0
- package/dist/models/ReceivedDocumentStatsResponse.js +52 -0
- package/dist/models/ReferenceInfo.d.ts +9 -18
- package/dist/models/ReferenceInfo.js +4 -4
- package/dist/models/SentDocumentDetail.d.ts +107 -0
- package/dist/models/SentDocumentDetail.js +75 -0
- package/dist/models/SentDocumentListResponse.d.ts +46 -0
- package/dist/models/SentDocumentListResponse.js +54 -0
- package/dist/models/SentDocumentSummary.d.ts +94 -0
- package/dist/models/SentDocumentSummary.js +70 -0
- package/dist/models/SentDocumentSummaryBusiness.d.ts +38 -0
- package/dist/models/SentDocumentSummaryBusiness.js +50 -0
- package/dist/models/StartCertification200Response.d.ts +32 -0
- package/dist/models/StartCertification200Response.js +48 -0
- package/dist/models/StartCertificationRequest.d.ts +51 -0
- package/dist/models/StartCertificationRequest.js +61 -0
- package/dist/models/Subquantity.d.ts +6 -6
- package/dist/models/Subquantity.js +3 -3
- package/dist/models/Subtotal.d.ts +18 -12
- package/dist/models/Subtotal.js +8 -10
- package/dist/models/TaxSequence.d.ts +68 -10
- package/dist/models/TaxSequence.js +34 -8
- package/dist/models/TaxSequenceCreated.d.ts +64 -0
- package/dist/models/TaxSequenceCreated.js +60 -0
- package/dist/models/Totals.d.ts +29 -32
- package/dist/models/Totals.js +5 -6
- package/dist/models/Transport.d.ts +26 -14
- package/dist/models/Transport.js +11 -7
- package/dist/models/UpdateTaxSequenceRequest.d.ts +64 -0
- package/dist/models/UpdateTaxSequenceRequest.js +60 -0
- package/dist/models/UploadCertificateResponse.d.ts +7 -7
- package/dist/models/UploadCertificateResponse.js +3 -3
- package/dist/models/VoidTaxSequence200Response.d.ts +39 -0
- package/dist/models/VoidTaxSequence200Response.js +51 -0
- package/dist/models/VoidTaxSequence200ResponseData.d.ts +44 -0
- package/dist/models/VoidTaxSequence200ResponseData.js +52 -0
- package/dist/models/VoidTaxSequenceRequest.d.ts +50 -0
- package/dist/models/VoidTaxSequenceRequest.js +62 -0
- package/dist/models/WebhookConfigDetail.d.ts +81 -0
- package/dist/models/WebhookConfigDetail.js +65 -0
- package/dist/models/WebhookConfigResponse.d.ts +21 -9
- package/dist/models/WebhookConfigResponse.js +7 -3
- package/dist/models/WebhookEventType.d.ts +9 -8
- package/dist/models/WebhookEventType.js +9 -8
- package/dist/models/WebhookNotificationPayload.d.ts +10 -9
- package/dist/models/WebhookNotificationPayload.js +3 -3
- package/dist/models/WebhookStats.d.ts +45 -0
- package/dist/models/WebhookStats.js +53 -0
- package/dist/models/WebhookStatsStats.d.ts +62 -0
- package/dist/models/WebhookStatsStats.js +58 -0
- package/dist/models/index.d.ts +47 -1
- package/dist/models/index.js +47 -1
- package/dist/runtime.d.ts +3 -3
- package/dist/runtime.js +3 -3
- package/docs/AccountType.md +2 -2
- package/docs/AdditionalInfo.md +21 -6
- package/docs/AlternativeCurrency.md +26 -3
- package/docs/ApprovalItem.md +48 -0
- package/docs/ApprovalListResponse.md +36 -0
- package/docs/AssociatedCompaniesApi.md +350 -42
- package/docs/AssociatedCompany.md +15 -10
- package/docs/AssociatedCompanySubscription.md +1 -1
- package/docs/AssociatedCompanySubscriptionPlan.md +1 -1
- package/docs/AuthenticationApi.md +8 -8
- package/docs/AutomatedCertificationApi.md +294 -0
- package/docs/BillingIndicator.md +2 -2
- package/docs/Buyer.md +24 -5
- package/docs/CertificationNiche.md +40 -0
- package/docs/CertificationNicheNicheItemsInner.md +36 -0
- package/docs/CertificationStatus.md +38 -0
- package/docs/CommercialApprovalsApi.md +114 -0
- package/docs/CompanyDocumentMetrics.md +40 -0
- package/docs/CompanyDocumentMetricsGroupByStatusInner.md +36 -0
- package/docs/CompanyDocumentMetricsGroupByStatusInnerCount.md +34 -0
- package/docs/CompanyDocumentMetricsMainBusiness.md +38 -0
- package/docs/CompanyDocumentMetricsTotals.md +36 -0
- package/docs/CompanyMetrics.md +50 -0
- package/docs/CompanyMetricsDocumentsStatus.md +38 -0
- package/docs/CreateAssociatedCompany201Response.md +1 -1
- package/docs/CreateTaxSequence201Response.md +36 -0
- package/docs/CreateTaxSequenceRequest.md +9 -4
- package/docs/DeleteAssociatedCompany200Response.md +34 -0
- package/docs/DigitalCertificatesApi.md +18 -16
- package/docs/DiscountOrSurcharge.md +7 -6
- package/docs/DocumentStatsResponse.md +40 -0
- package/docs/DocumentStatus.md +32 -0
- package/docs/DocumentsReceivedApi.md +175 -0
- package/docs/DocumentsSentApi.md +330 -0
- package/docs/ECFSubmissionApi.md +245 -13
- package/docs/EcfHistoryItem.md +50 -0
- package/docs/EcfStatsResponse.md +50 -0
- package/docs/EcfStatusResponse.md +56 -0
- package/docs/EcfStatusResponseMensajesInner.md +36 -0
- package/docs/EcfSubmissionResponse.md +22 -4
- package/docs/EcfSubmissionResponseDgiiResponse.md +40 -0
- package/docs/ElectronicDocument.md +52 -12
- package/docs/Environment.md +2 -2
- package/docs/ErrorResponse.md +6 -5
- package/docs/GetNextNumber200Response.md +1 -1
- package/docs/GetNextNumber200ResponseData.md +5 -3
- package/docs/InvoiceType.md +2 -2
- package/docs/InvoiceTypeSequence.md +33 -0
- package/docs/Item.md +42 -11
- package/docs/ItemAdditionalTax.md +1 -2
- package/docs/ItemAlternativeCurrency.md +40 -0
- package/docs/ItemCodesInner.md +36 -0
- package/docs/ItemDiscountInner.md +38 -0
- package/docs/ItemMiningInfo.md +40 -0
- package/docs/ListTaxSequences200Response.md +3 -1
- package/docs/OAuthTokenRequest.md +4 -4
- package/docs/OAuthTokenResponse.md +4 -4
- package/docs/Page.md +5 -6
- package/docs/PaginationMeta.md +40 -0
- package/docs/PaymentForm.md +36 -0
- package/docs/PaymentMethod.md +2 -2
- package/docs/PrintFormat.md +1 -2
- package/docs/ProcessingLog.md +38 -0
- package/docs/RateLimitErrorResponse.md +40 -0
- package/docs/ReceivedDocument.md +50 -0
- package/docs/ReceivedDocumentListResponse.md +38 -0
- package/docs/ReceivedDocumentStatsResponse.md +38 -0
- package/docs/ReferenceInfo.md +2 -2
- package/docs/ReportsApi.md +186 -0
- package/docs/SentDocumentDetail.md +58 -0
- package/docs/SentDocumentListResponse.md +38 -0
- package/docs/SentDocumentSummary.md +54 -0
- package/docs/SentDocumentSummaryBusiness.md +36 -0
- package/docs/StartCertification200Response.md +34 -0
- package/docs/StartCertificationRequest.md +40 -0
- package/docs/Subquantity.md +1 -2
- package/docs/Subtotal.md +5 -4
- package/docs/TaxSequence.md +21 -6
- package/docs/TaxSequenceCreated.md +44 -0
- package/docs/TaxSequencesApi.md +197 -38
- package/docs/Totals.md +2 -3
- package/docs/Transport.md +9 -6
- package/docs/UpdateTaxSequenceRequest.md +44 -0
- package/docs/UploadCertificateResponse.md +2 -3
- package/docs/VoidTaxSequence200Response.md +36 -0
- package/docs/VoidTaxSequence200ResponseData.md +38 -0
- package/docs/VoidTaxSequenceRequest.md +40 -0
- package/docs/WebhookConfigDetail.md +50 -0
- package/docs/WebhookConfigResponse.md +6 -3
- package/docs/WebhookConfigurationApi.md +47 -50
- package/docs/WebhookEventType.md +1 -2
- package/docs/WebhookNotificationPayload.md +3 -3
- package/docs/WebhookStats.md +38 -0
- package/docs/WebhookStatsStats.md +44 -0
- package/package.json +1 -1
- package/src/apis/AssociatedCompaniesApi.ts +455 -57
- package/src/apis/AuthenticationApi.ts +11 -11
- package/src/apis/AutomatedCertificationApi.ts +382 -0
- package/src/apis/CommercialApprovalsApi.ts +234 -0
- package/src/apis/DigitalCertificatesApi.ts +17 -17
- package/src/apis/DocumentsReceivedApi.ts +256 -0
- package/src/apis/DocumentsSentApi.ts +481 -0
- package/src/apis/ECFSubmissionApi.ts +309 -17
- package/src/apis/ReportsApi.ts +323 -0
- package/src/apis/TaxSequencesApi.ts +264 -63
- package/src/apis/WebhookConfigurationApi.ts +90 -76
- package/src/apis/index.ts +5 -0
- package/src/models/AccountType.ts +4 -8
- package/src/models/AdditionalInfo.ts +80 -16
- package/src/models/AlternativeCurrency.ts +102 -8
- package/src/models/ApprovalItem.ts +121 -0
- package/src/models/ApprovalListResponse.ts +88 -0
- package/src/models/AssociatedCompany.ts +53 -22
- package/src/models/AssociatedCompanySubscription.ts +5 -5
- package/src/models/AssociatedCompanySubscriptionPlan.ts +4 -4
- package/src/models/BillingIndicator.ts +4 -10
- package/src/models/Buyer.ts +91 -11
- package/src/models/CertificationNiche.ts +97 -0
- package/src/models/CertificationNicheNicheItemsInner.ts +73 -0
- package/src/models/CertificationStatus.ts +94 -0
- package/src/models/CompanyDocumentMetrics.ts +111 -0
- package/src/models/CompanyDocumentMetricsGroupByStatusInner.ts +81 -0
- package/src/models/CompanyDocumentMetricsGroupByStatusInnerCount.ts +65 -0
- package/src/models/CompanyDocumentMetricsMainBusiness.ts +81 -0
- package/src/models/CompanyDocumentMetricsTotals.ts +73 -0
- package/src/models/CompanyMetrics.ts +137 -0
- package/src/models/CompanyMetricsDocumentsStatus.ts +81 -0
- package/src/models/CreateAssociatedCompany201Response.ts +3 -3
- package/src/models/CreateTaxSequence201Response.ts +81 -0
- package/src/models/CreateTaxSequenceRequest.ts +46 -17
- package/src/models/DeleteAssociatedCompany200Response.ts +65 -0
- package/src/models/DiscountOrSurcharge.ts +38 -23
- package/src/models/DocumentStatsResponse.ts +89 -0
- package/src/models/DocumentStatus.ts +56 -0
- package/src/models/EcfHistoryItem.ts +153 -0
- package/src/models/EcfStatsResponse.ts +129 -0
- package/src/models/EcfStatusResponse.ts +193 -0
- package/src/models/EcfStatusResponseMensajesInner.ts +73 -0
- package/src/models/EcfSubmissionResponse.ts +96 -15
- package/src/models/EcfSubmissionResponseDgiiResponse.ts +89 -0
- package/src/models/ElectronicDocument.ts +252 -97
- package/src/models/Environment.ts +4 -8
- package/src/models/ErrorResponse.ts +15 -7
- package/src/models/GetNextNumber200Response.ts +3 -3
- package/src/models/GetNextNumber200ResponseData.ts +13 -5
- package/src/models/InvoiceType.ts +6 -14
- package/src/models/InvoiceTypeSequence.ts +61 -0
- package/src/models/Item.ts +180 -27
- package/src/models/ItemAdditionalTax.ts +8 -9
- package/src/models/ItemAlternativeCurrency.ts +89 -0
- package/src/models/ItemCodesInner.ts +73 -0
- package/src/models/ItemDiscountInner.ts +81 -0
- package/src/models/ItemMiningInfo.ts +89 -0
- package/src/models/ListTaxSequences200Response.ts +18 -3
- package/src/models/OAuthTokenRequest.ts +6 -11
- package/src/models/OAuthTokenResponse.ts +7 -9
- package/src/models/Page.ts +22 -25
- package/src/models/PaginationMeta.ts +89 -0
- package/src/models/PaymentForm.ts +85 -0
- package/src/models/PaymentMethod.ts +4 -13
- package/src/models/PrintFormat.ts +3 -7
- package/src/models/ProcessingLog.ts +94 -0
- package/src/models/RateLimitErrorResponse.ts +89 -0
- package/src/models/ReceivedDocument.ts +137 -0
- package/src/models/ReceivedDocumentListResponse.ts +96 -0
- package/src/models/ReceivedDocumentStatsResponse.ts +81 -0
- package/src/models/ReferenceInfo.ts +10 -19
- package/src/models/SentDocumentDetail.ts +185 -0
- package/src/models/SentDocumentListResponse.ts +96 -0
- package/src/models/SentDocumentSummary.ts +162 -0
- package/src/models/SentDocumentSummaryBusiness.ts +73 -0
- package/src/models/StartCertification200Response.ts +65 -0
- package/src/models/StartCertificationRequest.ts +102 -0
- package/src/models/Subquantity.ts +6 -6
- package/src/models/Subtotal.ts +23 -17
- package/src/models/TaxSequence.ts +94 -19
- package/src/models/TaxSequenceCreated.ts +122 -0
- package/src/models/Totals.ts +31 -41
- package/src/models/Transport.ts +34 -18
- package/src/models/UpdateTaxSequenceRequest.ts +122 -0
- package/src/models/UploadCertificateResponse.ts +7 -7
- package/src/models/VoidTaxSequence200Response.ts +81 -0
- package/src/models/VoidTaxSequence200ResponseData.ts +81 -0
- package/src/models/VoidTaxSequenceRequest.ts +93 -0
- package/src/models/WebhookConfigDetail.ts +137 -0
- package/src/models/WebhookConfigResponse.ts +25 -9
- package/src/models/WebhookEventType.ts +9 -8
- package/src/models/WebhookNotificationPayload.ts +10 -9
- package/src/models/WebhookStats.ts +89 -0
- package/src/models/WebhookStatsStats.ts +105 -0
- package/src/models/index.ts +47 -1
- package/src/runtime.ts +3 -3
|
@@ -0,0 +1,330 @@
|
|
|
1
|
+
# DocumentsSentApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**downloadDocument**](DocumentsSentApi.md#downloaddocument) | **GET** /documents/download | Download document XML |
|
|
8
|
+
| [**getDocument**](DocumentsSentApi.md#getdocument) | **GET** /documents/{id} | Get document details |
|
|
9
|
+
| [**getDocumentStats**](DocumentsSentApi.md#getdocumentstats) | **GET** /documents/stats/summary | Get document statistics |
|
|
10
|
+
| [**listSentDocuments**](DocumentsSentApi.md#listsentdocuments) | **GET** /documents/sent | List sent documents |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## downloadDocument
|
|
15
|
+
|
|
16
|
+
> string downloadDocument(fileUrl)
|
|
17
|
+
|
|
18
|
+
Download document XML
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import {
|
|
24
|
+
Configuration,
|
|
25
|
+
DocumentsSentApi,
|
|
26
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
27
|
+
import type { DownloadDocumentRequest } from '@pronesoft-rd/ecf-sdk';
|
|
28
|
+
|
|
29
|
+
async function example() {
|
|
30
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
31
|
+
const config = new Configuration({
|
|
32
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
33
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
34
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
35
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
36
|
+
});
|
|
37
|
+
const api = new DocumentsSentApi(config);
|
|
38
|
+
|
|
39
|
+
const body = {
|
|
40
|
+
// string
|
|
41
|
+
fileUrl: fileUrl_example,
|
|
42
|
+
} satisfies DownloadDocumentRequest;
|
|
43
|
+
|
|
44
|
+
try {
|
|
45
|
+
const data = await api.downloadDocument(body);
|
|
46
|
+
console.log(data);
|
|
47
|
+
} catch (error) {
|
|
48
|
+
console.error(error);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
// Run the test
|
|
53
|
+
example().catch(console.error);
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
| Name | Type | Description | Notes |
|
|
60
|
+
|------------- | ------------- | ------------- | -------------|
|
|
61
|
+
| **fileUrl** | `string` | | [Defaults to `undefined`] |
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
**string**
|
|
66
|
+
|
|
67
|
+
### Authorization
|
|
68
|
+
|
|
69
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
70
|
+
|
|
71
|
+
### HTTP request headers
|
|
72
|
+
|
|
73
|
+
- **Content-Type**: Not defined
|
|
74
|
+
- **Accept**: `application/xml`, `application/json`
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### HTTP response details
|
|
78
|
+
| Status code | Description | Response headers |
|
|
79
|
+
|-------------|-------------|------------------|
|
|
80
|
+
| **200** | XML file content | - |
|
|
81
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
82
|
+
|
|
83
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
## getDocument
|
|
87
|
+
|
|
88
|
+
> SentDocumentDetail getDocument(id, xTenantId)
|
|
89
|
+
|
|
90
|
+
Get document details
|
|
91
|
+
|
|
92
|
+
### Example
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
import {
|
|
96
|
+
Configuration,
|
|
97
|
+
DocumentsSentApi,
|
|
98
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
99
|
+
import type { GetDocumentRequest } from '@pronesoft-rd/ecf-sdk';
|
|
100
|
+
|
|
101
|
+
async function example() {
|
|
102
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
103
|
+
const config = new Configuration({
|
|
104
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
105
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
106
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
107
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
108
|
+
});
|
|
109
|
+
const api = new DocumentsSentApi(config);
|
|
110
|
+
|
|
111
|
+
const body = {
|
|
112
|
+
// string
|
|
113
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
114
|
+
// string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. (optional)
|
|
115
|
+
xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
|
|
116
|
+
} satisfies GetDocumentRequest;
|
|
117
|
+
|
|
118
|
+
try {
|
|
119
|
+
const data = await api.getDocument(body);
|
|
120
|
+
console.log(data);
|
|
121
|
+
} catch (error) {
|
|
122
|
+
console.error(error);
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
// Run the test
|
|
127
|
+
example().catch(console.error);
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Parameters
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
| Name | Type | Description | Notes |
|
|
134
|
+
|------------- | ------------- | ------------- | -------------|
|
|
135
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
136
|
+
| **xTenantId** | `string` | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. | [Optional] [Defaults to `undefined`] |
|
|
137
|
+
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
[**SentDocumentDetail**](SentDocumentDetail.md)
|
|
141
|
+
|
|
142
|
+
### Authorization
|
|
143
|
+
|
|
144
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
145
|
+
|
|
146
|
+
### HTTP request headers
|
|
147
|
+
|
|
148
|
+
- **Content-Type**: Not defined
|
|
149
|
+
- **Accept**: `application/json`
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
### HTTP response details
|
|
153
|
+
| Status code | Description | Response headers |
|
|
154
|
+
|-------------|-------------|------------------|
|
|
155
|
+
| **200** | Document details | - |
|
|
156
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
157
|
+
|
|
158
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
## getDocumentStats
|
|
162
|
+
|
|
163
|
+
> DocumentStatsResponse getDocumentStats(xTenantId, period)
|
|
164
|
+
|
|
165
|
+
Get document statistics
|
|
166
|
+
|
|
167
|
+
### Example
|
|
168
|
+
|
|
169
|
+
```ts
|
|
170
|
+
import {
|
|
171
|
+
Configuration,
|
|
172
|
+
DocumentsSentApi,
|
|
173
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
174
|
+
import type { GetDocumentStatsRequest } from '@pronesoft-rd/ecf-sdk';
|
|
175
|
+
|
|
176
|
+
async function example() {
|
|
177
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
178
|
+
const config = new Configuration({
|
|
179
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
180
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
181
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
182
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
183
|
+
});
|
|
184
|
+
const api = new DocumentsSentApi(config);
|
|
185
|
+
|
|
186
|
+
const body = {
|
|
187
|
+
// string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. (optional)
|
|
188
|
+
xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
|
|
189
|
+
// '7d' | '30d' | '90d' (optional)
|
|
190
|
+
period: period_example,
|
|
191
|
+
} satisfies GetDocumentStatsRequest;
|
|
192
|
+
|
|
193
|
+
try {
|
|
194
|
+
const data = await api.getDocumentStats(body);
|
|
195
|
+
console.log(data);
|
|
196
|
+
} catch (error) {
|
|
197
|
+
console.error(error);
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
// Run the test
|
|
202
|
+
example().catch(console.error);
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### Parameters
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
| Name | Type | Description | Notes |
|
|
209
|
+
|------------- | ------------- | ------------- | -------------|
|
|
210
|
+
| **xTenantId** | `string` | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. | [Optional] [Defaults to `undefined`] |
|
|
211
|
+
| **period** | `7d`, `30d`, `90d` | | [Optional] [Defaults to `'30d'`] [Enum: 7d, 30d, 90d] |
|
|
212
|
+
|
|
213
|
+
### Return type
|
|
214
|
+
|
|
215
|
+
[**DocumentStatsResponse**](DocumentStatsResponse.md)
|
|
216
|
+
|
|
217
|
+
### Authorization
|
|
218
|
+
|
|
219
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
220
|
+
|
|
221
|
+
### HTTP request headers
|
|
222
|
+
|
|
223
|
+
- **Content-Type**: Not defined
|
|
224
|
+
- **Accept**: `application/json`
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
### HTTP response details
|
|
228
|
+
| Status code | Description | Response headers |
|
|
229
|
+
|-------------|-------------|------------------|
|
|
230
|
+
| **200** | Document statistics | - |
|
|
231
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
232
|
+
|
|
233
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
## listSentDocuments
|
|
237
|
+
|
|
238
|
+
> SentDocumentListResponse listSentDocuments(xTenantId, env, ecf, type, status, dateFrom, dateTo, page, limit)
|
|
239
|
+
|
|
240
|
+
List sent documents
|
|
241
|
+
|
|
242
|
+
### Example
|
|
243
|
+
|
|
244
|
+
```ts
|
|
245
|
+
import {
|
|
246
|
+
Configuration,
|
|
247
|
+
DocumentsSentApi,
|
|
248
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
249
|
+
import type { ListSentDocumentsRequest } from '@pronesoft-rd/ecf-sdk';
|
|
250
|
+
|
|
251
|
+
async function example() {
|
|
252
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
253
|
+
const config = new Configuration({
|
|
254
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
255
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
256
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
257
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
258
|
+
});
|
|
259
|
+
const api = new DocumentsSentApi(config);
|
|
260
|
+
|
|
261
|
+
const body = {
|
|
262
|
+
// string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. (optional)
|
|
263
|
+
xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
|
|
264
|
+
// Environment (optional)
|
|
265
|
+
env: ...,
|
|
266
|
+
// string (optional)
|
|
267
|
+
ecf: ecf_example,
|
|
268
|
+
// string (optional)
|
|
269
|
+
type: type_example,
|
|
270
|
+
// 'APPROVED' | 'REJECTED' | 'IN_PROCESS' | 'CONTINGENCY' | 'ERROR' (optional)
|
|
271
|
+
status: status_example,
|
|
272
|
+
// Date (optional)
|
|
273
|
+
dateFrom: 2013-10-20,
|
|
274
|
+
// Date (optional)
|
|
275
|
+
dateTo: 2013-10-20,
|
|
276
|
+
// number (optional)
|
|
277
|
+
page: 56,
|
|
278
|
+
// number (optional)
|
|
279
|
+
limit: 56,
|
|
280
|
+
} satisfies ListSentDocumentsRequest;
|
|
281
|
+
|
|
282
|
+
try {
|
|
283
|
+
const data = await api.listSentDocuments(body);
|
|
284
|
+
console.log(data);
|
|
285
|
+
} catch (error) {
|
|
286
|
+
console.error(error);
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
// Run the test
|
|
291
|
+
example().catch(console.error);
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
### Parameters
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
| Name | Type | Description | Notes |
|
|
298
|
+
|------------- | ------------- | ------------- | -------------|
|
|
299
|
+
| **xTenantId** | `string` | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. | [Optional] [Defaults to `undefined`] |
|
|
300
|
+
| **env** | `Environment` | | [Optional] [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
|
|
301
|
+
| **ecf** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
302
|
+
| **type** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
303
|
+
| **status** | `APPROVED`, `REJECTED`, `IN_PROCESS`, `CONTINGENCY`, `ERROR` | | [Optional] [Defaults to `undefined`] [Enum: APPROVED, REJECTED, IN_PROCESS, CONTINGENCY, ERROR] |
|
|
304
|
+
| **dateFrom** | `Date` | | [Optional] [Defaults to `undefined`] |
|
|
305
|
+
| **dateTo** | `Date` | | [Optional] [Defaults to `undefined`] |
|
|
306
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
307
|
+
| **limit** | `number` | | [Optional] [Defaults to `10`] |
|
|
308
|
+
|
|
309
|
+
### Return type
|
|
310
|
+
|
|
311
|
+
[**SentDocumentListResponse**](SentDocumentListResponse.md)
|
|
312
|
+
|
|
313
|
+
### Authorization
|
|
314
|
+
|
|
315
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
316
|
+
|
|
317
|
+
### HTTP request headers
|
|
318
|
+
|
|
319
|
+
- **Content-Type**: Not defined
|
|
320
|
+
- **Accept**: `application/json`
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
### HTTP response details
|
|
324
|
+
| Status code | Description | Response headers |
|
|
325
|
+
|-------------|-------------|------------------|
|
|
326
|
+
| **200** | Paginated list of sent documents | - |
|
|
327
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
328
|
+
|
|
329
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
330
|
+
|
package/docs/ECFSubmissionApi.md
CHANGED
|
@@ -4,17 +4,248 @@ All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**getEcfHistory**](ECFSubmissionApi.md#getecfhistory) | **GET** /{environment}/ecf/responses/history | Get submission history (last 50 documents) |
|
|
8
|
+
| [**getEcfStats**](ECFSubmissionApi.md#getecfstats) | **GET** /{environment}/ecf/responses/stats | Get submission statistics (last 30 days) |
|
|
9
|
+
| [**getEcfStatus**](ECFSubmissionApi.md#getecfstatus) | **GET** /{environment}/ecf/status/{trackId} | Get document status by trackId |
|
|
7
10
|
| [**submitEcf**](ECFSubmissionApi.md#submitecf) | **POST** /{environment}/ecf/submit | Submit e-CF document to DGII |
|
|
8
11
|
|
|
9
12
|
|
|
10
13
|
|
|
14
|
+
## getEcfHistory
|
|
15
|
+
|
|
16
|
+
> Array<EcfHistoryItem> getEcfHistory(environment, xTenantId)
|
|
17
|
+
|
|
18
|
+
Get submission history (last 50 documents)
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import {
|
|
24
|
+
Configuration,
|
|
25
|
+
ECFSubmissionApi,
|
|
26
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
27
|
+
import type { GetEcfHistoryRequest } from '@pronesoft-rd/ecf-sdk';
|
|
28
|
+
|
|
29
|
+
async function example() {
|
|
30
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
31
|
+
const config = new Configuration({
|
|
32
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
33
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
34
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
35
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
36
|
+
});
|
|
37
|
+
const api = new ECFSubmissionApi(config);
|
|
38
|
+
|
|
39
|
+
const body = {
|
|
40
|
+
// Environment
|
|
41
|
+
environment: ...,
|
|
42
|
+
// string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. (optional)
|
|
43
|
+
xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
|
|
44
|
+
} satisfies GetEcfHistoryRequest;
|
|
45
|
+
|
|
46
|
+
try {
|
|
47
|
+
const data = await api.getEcfHistory(body);
|
|
48
|
+
console.log(data);
|
|
49
|
+
} catch (error) {
|
|
50
|
+
console.error(error);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
// Run the test
|
|
55
|
+
example().catch(console.error);
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Parameters
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
| Name | Type | Description | Notes |
|
|
62
|
+
|------------- | ------------- | ------------- | -------------|
|
|
63
|
+
| **environment** | `Environment` | | [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
|
|
64
|
+
| **xTenantId** | `string` | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. | [Optional] [Defaults to `undefined`] |
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
[**Array<EcfHistoryItem>**](EcfHistoryItem.md)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: Not defined
|
|
77
|
+
- **Accept**: `application/json`
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### HTTP response details
|
|
81
|
+
| Status code | Description | Response headers |
|
|
82
|
+
|-------------|-------------|------------------|
|
|
83
|
+
| **200** | Document history | - |
|
|
84
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
85
|
+
|
|
86
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## getEcfStats
|
|
90
|
+
|
|
91
|
+
> EcfStatsResponse getEcfStats(environment, xTenantId)
|
|
92
|
+
|
|
93
|
+
Get submission statistics (last 30 days)
|
|
94
|
+
|
|
95
|
+
### Example
|
|
96
|
+
|
|
97
|
+
```ts
|
|
98
|
+
import {
|
|
99
|
+
Configuration,
|
|
100
|
+
ECFSubmissionApi,
|
|
101
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
102
|
+
import type { GetEcfStatsRequest } from '@pronesoft-rd/ecf-sdk';
|
|
103
|
+
|
|
104
|
+
async function example() {
|
|
105
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
106
|
+
const config = new Configuration({
|
|
107
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
108
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
109
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
110
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
111
|
+
});
|
|
112
|
+
const api = new ECFSubmissionApi(config);
|
|
113
|
+
|
|
114
|
+
const body = {
|
|
115
|
+
// Environment
|
|
116
|
+
environment: ...,
|
|
117
|
+
// string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. (optional)
|
|
118
|
+
xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
|
|
119
|
+
} satisfies GetEcfStatsRequest;
|
|
120
|
+
|
|
121
|
+
try {
|
|
122
|
+
const data = await api.getEcfStats(body);
|
|
123
|
+
console.log(data);
|
|
124
|
+
} catch (error) {
|
|
125
|
+
console.error(error);
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
// Run the test
|
|
130
|
+
example().catch(console.error);
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Parameters
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
| Name | Type | Description | Notes |
|
|
137
|
+
|------------- | ------------- | ------------- | -------------|
|
|
138
|
+
| **environment** | `Environment` | | [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
|
|
139
|
+
| **xTenantId** | `string` | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. | [Optional] [Defaults to `undefined`] |
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
[**EcfStatsResponse**](EcfStatsResponse.md)
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: Not defined
|
|
152
|
+
- **Accept**: `application/json`
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
### HTTP response details
|
|
156
|
+
| Status code | Description | Response headers |
|
|
157
|
+
|-------------|-------------|------------------|
|
|
158
|
+
| **200** | Submission statistics | - |
|
|
159
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
160
|
+
|
|
161
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
## getEcfStatus
|
|
165
|
+
|
|
166
|
+
> EcfStatusResponse getEcfStatus(environment, trackId, xTenantId)
|
|
167
|
+
|
|
168
|
+
Get document status by trackId
|
|
169
|
+
|
|
170
|
+
### Example
|
|
171
|
+
|
|
172
|
+
```ts
|
|
173
|
+
import {
|
|
174
|
+
Configuration,
|
|
175
|
+
ECFSubmissionApi,
|
|
176
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
177
|
+
import type { GetEcfStatusRequest } from '@pronesoft-rd/ecf-sdk';
|
|
178
|
+
|
|
179
|
+
async function example() {
|
|
180
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
181
|
+
const config = new Configuration({
|
|
182
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
183
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
184
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
185
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
186
|
+
});
|
|
187
|
+
const api = new ECFSubmissionApi(config);
|
|
188
|
+
|
|
189
|
+
const body = {
|
|
190
|
+
// Environment
|
|
191
|
+
environment: ...,
|
|
192
|
+
// string
|
|
193
|
+
trackId: trackId_example,
|
|
194
|
+
// string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. (optional)
|
|
195
|
+
xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
|
|
196
|
+
} satisfies GetEcfStatusRequest;
|
|
197
|
+
|
|
198
|
+
try {
|
|
199
|
+
const data = await api.getEcfStatus(body);
|
|
200
|
+
console.log(data);
|
|
201
|
+
} catch (error) {
|
|
202
|
+
console.error(error);
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
// Run the test
|
|
207
|
+
example().catch(console.error);
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Parameters
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
| Name | Type | Description | Notes |
|
|
214
|
+
|------------- | ------------- | ------------- | -------------|
|
|
215
|
+
| **environment** | `Environment` | | [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
|
|
216
|
+
| **trackId** | `string` | | [Defaults to `undefined`] |
|
|
217
|
+
| **xTenantId** | `string` | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. | [Optional] [Defaults to `undefined`] |
|
|
218
|
+
|
|
219
|
+
### Return type
|
|
220
|
+
|
|
221
|
+
[**EcfStatusResponse**](EcfStatusResponse.md)
|
|
222
|
+
|
|
223
|
+
### Authorization
|
|
224
|
+
|
|
225
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
226
|
+
|
|
227
|
+
### HTTP request headers
|
|
228
|
+
|
|
229
|
+
- **Content-Type**: Not defined
|
|
230
|
+
- **Accept**: `application/json`
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
### HTTP response details
|
|
234
|
+
| Status code | Description | Response headers |
|
|
235
|
+
|-------------|-------------|------------------|
|
|
236
|
+
| **200** | Document status | - |
|
|
237
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
238
|
+
|
|
239
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
240
|
+
|
|
241
|
+
|
|
11
242
|
## submitEcf
|
|
12
243
|
|
|
13
|
-
> EcfSubmissionResponse submitEcf(
|
|
244
|
+
> EcfSubmissionResponse submitEcf(environment, electronicDocument, xTenantId)
|
|
14
245
|
|
|
15
246
|
Submit e-CF document to DGII
|
|
16
247
|
|
|
17
|
-
Submits an electronic tax document
|
|
248
|
+
Submits an electronic tax document. Handles XML signing, queuing, contingency mode, and DGII communication automatically. IMPORTANT: In Sandbox the environment field in body MUST be TesteCF.
|
|
18
249
|
|
|
19
250
|
### Example
|
|
20
251
|
|
|
@@ -22,11 +253,11 @@ Submits an electronic tax document to the DGII via the Pronesoft platform. Prone
|
|
|
22
253
|
import {
|
|
23
254
|
Configuration,
|
|
24
255
|
ECFSubmissionApi,
|
|
25
|
-
} from '@pronesoft/ecf-sdk';
|
|
26
|
-
import type { SubmitEcfRequest } from '@pronesoft/ecf-sdk';
|
|
256
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
257
|
+
import type { SubmitEcfRequest } from '@pronesoft-rd/ecf-sdk';
|
|
27
258
|
|
|
28
259
|
async function example() {
|
|
29
|
-
console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
|
|
260
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
30
261
|
const config = new Configuration({
|
|
31
262
|
// To configure OAuth2 access token for authorization: oauth2 application
|
|
32
263
|
accessToken: "YOUR ACCESS TOKEN",
|
|
@@ -36,12 +267,12 @@ async function example() {
|
|
|
36
267
|
const api = new ECFSubmissionApi(config);
|
|
37
268
|
|
|
38
269
|
const body = {
|
|
39
|
-
//
|
|
40
|
-
xTenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
41
|
-
// Environment | Target submission environment.
|
|
270
|
+
// Environment
|
|
42
271
|
environment: ...,
|
|
43
272
|
// ElectronicDocument
|
|
44
273
|
electronicDocument: ...,
|
|
274
|
+
// string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. (optional)
|
|
275
|
+
xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
|
|
45
276
|
} satisfies SubmitEcfRequest;
|
|
46
277
|
|
|
47
278
|
try {
|
|
@@ -61,9 +292,9 @@ example().catch(console.error);
|
|
|
61
292
|
|
|
62
293
|
| Name | Type | Description | Notes |
|
|
63
294
|
|------------- | ------------- | ------------- | -------------|
|
|
64
|
-
| **
|
|
65
|
-
| **environment** | `Environment` | Target submission environment. | [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
|
|
295
|
+
| **environment** | `Environment` | | [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
|
|
66
296
|
| **electronicDocument** | [ElectronicDocument](ElectronicDocument.md) | | |
|
|
297
|
+
| **xTenantId** | `string` | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. | [Optional] [Defaults to `undefined`] |
|
|
67
298
|
|
|
68
299
|
### Return type
|
|
69
300
|
|
|
@@ -82,9 +313,10 @@ example().catch(console.error);
|
|
|
82
313
|
### HTTP response details
|
|
83
314
|
| Status code | Description | Response headers |
|
|
84
315
|
|-------------|-------------|------------------|
|
|
85
|
-
| **200** | Document
|
|
86
|
-
| **400** | Validation error (400
|
|
87
|
-
| **401** |
|
|
316
|
+
| **200** | Document submitted (approved, queued, or contingency mode) | - |
|
|
317
|
+
| **400** | Validation error (400). Check the message field for details. | - |
|
|
318
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
319
|
+
| **429** | Rate limit exceeded. Retry after indicated seconds. | - |
|
|
88
320
|
|
|
89
321
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
90
322
|
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# EcfHistoryItem
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`trackId` | string
|
|
11
|
+
`encf` | string
|
|
12
|
+
`documentType` | string
|
|
13
|
+
`status` | [DocumentStatus](DocumentStatus.md)
|
|
14
|
+
`rnc` | string
|
|
15
|
+
`environment` | [Environment](Environment.md)
|
|
16
|
+
`createdAt` | Date
|
|
17
|
+
`logs` | [Array<ProcessingLog>](ProcessingLog.md)
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { EcfHistoryItem } from '@pronesoft-rd/ecf-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"id": null,
|
|
27
|
+
"trackId": null,
|
|
28
|
+
"encf": null,
|
|
29
|
+
"documentType": null,
|
|
30
|
+
"status": null,
|
|
31
|
+
"rnc": null,
|
|
32
|
+
"environment": null,
|
|
33
|
+
"createdAt": null,
|
|
34
|
+
"logs": null,
|
|
35
|
+
} satisfies EcfHistoryItem
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as EcfHistoryItem
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|