@timbro/invoices 0.10.3 → 0.12.0

package/dist/generated/types.gen.d.ts

@@ -9,11 +9,6 @@ export type AcceptedMembership = {
     organization_id: string;
     role: MembershipRole;
 };
-export type ActiveCertificateCustodyBindingResource = {
-    binding_id: string;
-    certificate_version: string;
-    expected_certificate_sha256: string;
-};
 /**
  * Buyer identity alternatives admitted by official conditional Type 33 and Type 34 `Comprador`.
  */
@@ -124,7 +119,8 @@ export type Buyer = {
     tax_id: string;
 };
 /**
- * Actor-facing buyer-delivery milestone projected from the immutable lifecycle event ledger.
+ * Whether the buyer may receive the e-CF: ready once DGII received it and answered `Aceptado` or
+ * `Aceptado Condicional`, projected from the immutable lifecycle event ledger.
  */
 export type BuyerDeliveryReadinessResource = {
     status: "not_applicable";
@@ -204,12 +200,6 @@ export type CertificateCustodyBindingResource = {
     legal_issuer_id: string;
     organization_id: string;
 };
-export type CertificateCustodyCertificateResource = {
-    certificate_expires_at: string;
-    certificate_sha256: string;
-    certificate_subject_serial_number: string;
-    effect_replay_retention_seconds: number;
-};
 export type CertificateCustodyCertificateVersionResource = {
     certificate_custody_certificate_version: LedgerCounter;
     certificate_not_after: string;
@@ -219,25 +209,6 @@ export type CertificateCustodyCertificateVersionResource = {
     effect_replay_retention_seconds: number;
     signature_algorithm: CertificateCustodySignatureAlgorithm;
 };
-export type CertificateCustodyReadiness = {
-    environment: FiscalEnvironment;
-    legal_issuer_id: string;
-    organization_id: string;
-    status: "not_configured";
-} | {
-    binding: EnrolledCertificateCustodyBindingResource;
-    environment: FiscalEnvironment;
-    legal_issuer_id: string;
-    organization_id: string;
-    status: "awaiting_certificate_registration";
-} | {
-    binding: ActiveCertificateCustodyBindingResource;
-    certificate: CertificateCustodyCertificateResource;
-    environment: FiscalEnvironment;
-    legal_issuer_id: string;
-    organization_id: string;
-    status: "ready";
-};
 /**
  * Signature algorithm pinned with a certificate-custody binding.
  */
@@ -329,6 +300,10 @@ export type CreateInvoiceDeliveryRequest = {
      * An `https` page where the buyer keeps this purchase; the email links it, and it grants no access.
      */
     accountClaimUrl?: string | undefined;
+    /**
+     * Files attached to the email beside its link. Omitted, the email attaches nothing.
+     */
+    attachments?: InvoiceDeliveryAttachmentSelection | undefined;
     recipientEmail: string;
 };
 export type CreateOrganizationRequest = {
@@ -401,6 +376,19 @@ export type DiscountOrSurcharge = {
  * The native artifact family selected for one schema validation.
  */
 export type DocumentSchemaArtifactKind = "complete_document" | "rfce";
+export type DocumentTypeIssuanceReadiness = {
+    numbering: NumberingRange;
+    status: "ready";
+    type: InvoiceType;
+} | {
+    numbering: null | NumberingRange;
+    /**
+     * Every condition that blocks this type: issuer, then certificate, then numbering.
+     */
+    reasons: Array<IssuanceReadinessReason>;
+    status: "actionRequired";
+    type: InvoiceType;
+};
 export type ElectronicFiscalDocumentEligibilityResource = {
     counterparty_class: FiscalCounterpartyClass;
     direction: FiscalIssuanceDirection;
@@ -424,9 +412,6 @@ export type EngineProblem = {
     path: string;
 };
 export type EngineProtocol = "timbro.fiscal-engine.v3";
-export type EnrolledCertificateCustodyBindingResource = {
-    binding_id: string;
-};
 /**
  * A successful deterministic fiscal-document engine response.
  */
@@ -655,18 +640,6 @@ export type FiscalLineWithLegalTip = {
     tax_exclusive_unit_price?: "1" | undefined;
     unit_price: string;
 };
-export type FiscalNumberAuthorizationDocumentReadiness = {
-    e31: FiscalNumberAuthorizationTypeReadiness;
-    e32: FiscalNumberAuthorizationTypeReadiness;
-    e33: FiscalNumberAuthorizationTypeReadiness;
-    e34: FiscalNumberAuthorizationTypeReadiness;
-    e41: FiscalNumberAuthorizationTypeReadiness;
-    e43: FiscalNumberAuthorizationTypeReadiness;
-    e44: FiscalNumberAuthorizationTypeReadiness;
-    e45: FiscalNumberAuthorizationTypeReadiness;
-    e46: FiscalNumberAuthorizationTypeReadiness;
-    e47: FiscalNumberAuthorizationTypeReadiness;
-};
 export type FiscalNumberAuthorizationHistoryResource = {
     authorizations: Array<FiscalNumberAuthorizationLineage>;
     document_type: ElectronicFiscalDocumentType;
@@ -691,16 +664,6 @@ export type FiscalNumberAuthorizationNextUnused = {
 } | {
     kind: "exhausted";
 };
-export type FiscalNumberAuthorizationReadiness = {
-    documents: FiscalNumberAuthorizationDocumentReadiness;
-    effective_on: string;
-    environment: FiscalEnvironment;
-    issuer_tax_id: string;
-    legal_issuer_id: string;
-    object: string;
-    source_connection_id: string;
-};
-export type FiscalNumberAuthorizationReadinessStatus = "ready" | "action_required";
 export type FiscalNumberAuthorizationResource = {
     created_at: string;
     document_type: ElectronicFiscalDocumentType;
@@ -723,16 +686,6 @@ export type FiscalNumberAuthorizationResource = {
     supersedes_id: string | null;
     verified_next_unused: FiscalNumberAuthorizationNextUnused;
 };
-export type FiscalNumberAuthorizationSelection = {
-    authorization_id: string;
-    ends_at: LedgerCounter;
-    expires_on: string | null;
-    next_available_sequence: LedgerCounter;
-    remaining_capacity: number;
-    starts_at: LedgerCounter;
-    state: FiscalNumberAuthorizationState;
-    verified_next_unused: FiscalNumberAuthorizationNextUnused;
-};
 /**
  * Origin of a fiscal-number authorization fact.
  */
@@ -741,13 +694,6 @@ export type FiscalNumberAuthorizationSourceKind = "official_source_manifest" | "
  * Lifecycle state of a fiscal-number authorization fact.
  */
 export type FiscalNumberAuthorizationState = "active" | "suspended" | "cancelled" | "superseded" | "exhausted" | "conflicting";
-export type FiscalNumberAuthorizationTypeReadiness = {
-    document_type: ElectronicFiscalDocumentType;
-    selected: null | FiscalNumberAuthorizationSelection;
-    status: FiscalNumberAuthorizationReadinessStatus;
-    unavailable_reason: null | FiscalNumberAuthorizationUnavailableReason;
-};
-export type FiscalNumberAuthorizationUnavailableReason = "authorization_missing" | "authorization_not_active" | "authorization_not_verified" | "authorization_not_observed" | "range_exhausted" | "authorization_expiration_invalid" | "authorization_expired" | "authorization_range_overlap";
 /**
  * Caller instruction that selects how a Fiscal operation obtains its e-NCF.
  *
@@ -922,7 +868,7 @@ export type HealthReadyResponse = {
     status: HealthStatus;
 };
 export type HealthStatus = "ok" | "unavailable";
-export type HostedCertificateImportEnvironment = "sandbox" | "production";
+export type HostedCertificateImportEnvironment = "sandbox" | "certification" | "production";
 export type HostedFiscalOperationSubmission = {
     /**
      * The hosted Checkout tenant the service acts for.
@@ -948,7 +894,7 @@ export type HostedImportResponse = {
     object: string;
     signer_subject_serial_number: string;
 };
-export type HostedInvoiceCredentialEnvironment = "sandbox" | "production";
+export type HostedInvoiceCredentialEnvironment = "sandbox" | "certification" | "production";
 export type HostedInvoiceCredentialRequest = {
     checkout_tenant_id: string;
     environment: HostedInvoiceCredentialEnvironment;
@@ -969,6 +915,11 @@ export type HostedInvoiceSubmission = {
     environment: FiscalEnvironment;
     request: InvoiceRequest;
 };
+export type HostedReceiverUrls = {
+    base_url: string;
+    commercial_approval_url: string;
+    reception_url: string;
+};
 export type HostedTenantResource = {
     /**
      * The binding identity the Checkout host uses for an exact release request.
@@ -976,6 +927,10 @@ export type HostedTenantResource = {
     hosted_tenant_binding_id: string;
     legal_issuer_id: string;
     organization_id: string;
+    /**
+     * Assigned receiver addresses; certificate import and communication checks establish readiness.
+     */
+    receiver_urls: HostedReceiverUrls;
     source_connection_id: string;
     /**
      * The endpoint this binding's Webhook deliveries are listed and replayed by.
@@ -1050,6 +1005,10 @@ export type InvoiceBuyer = {
     legalName: string;
     taxId: string;
 };
+/**
+ * Whether the buyer may receive the e-CF: `ready` once DGII received it and answered `Aceptado`
+ * or `Aceptado Condicional`, never at signing or submission alone.
+ */
 export type InvoiceBuyerDeliveryReadiness = {
     status: "notApplicable";
 } | {
@@ -1103,7 +1062,25 @@ export type InvoiceCreditNotePaymentTerms = {
     type: "free";
 };
 export type InvoiceDebitNoteModificationCode = "2" | "3";
+export type InvoiceDeliveryAttachmentSelection = {
+    /**
+     * Attach the printed representation as `{RNC}{e-NCF}.pdf`.
+     */
+    pdf?: boolean | undefined;
+    /**
+     * Attach the signed e-CF as `{RNC}{e-NCF}.xml`, DGII's file-name standard.
+     */
+    xml?: boolean | undefined;
+};
+/**
+ * The files this email attaches beside its link.
+ */
+export type InvoiceDeliveryAttachments = {
+    pdf: boolean;
+    xml: boolean;
+};
 export type InvoiceDeliveryResource = {
+    attachments: InvoiceDeliveryAttachments;
     createdAt: string;
     id: string;
     invoiceId: string;
@@ -1155,6 +1132,7 @@ export type InvoiceFiles = {
 };
 export type InvoiceFiscalIdentity = {
     eNcf: string;
+    signature: null | InvoiceSignature;
     type: InvoiceType;
 };
 export type InvoiceForeignCurrency = {
@@ -1802,6 +1780,27 @@ export type InvoiceResource = {
     type: InvoiceType;
     updatedAt: string;
 };
+/**
+ * The signature facts DGII requires on every printed e-CF, read from the signed document.
+ *
+ * Print the buyer's copy after DGII accepts the Invoice; DGII sequences the printed e-CF after
+ * its validation result, including the Type 32 below DOP 250,000 it validates by RFCE summary.
+ */
+export type InvoiceSignature = {
+    /**
+     * The first six characters of the signature value, printed below the QR code.
+     */
+    securityCode: string;
+    /**
+     * The exact `FechaHoraFirma` instant as RFC 3339 in DGII's fixed GMT-4, so its date and
+     * time read as the printed `dd-MM-aaaa HH:mm:ss`.
+     */
+    signedAt: string;
+    /**
+     * The DGII consultation URL the printed QR code encodes.
+     */
+    verificationUrl: string;
+};
 export type InvoiceSource = {
     contentSha256: string;
     id: string;
@@ -1909,6 +1908,30 @@ export type InvoiceWebhookEvent = {
         sourceConnectionId: string;
     };
     type: "invoice.ready";
+} | {
+    /**
+     * InvoiceDeliveryEventData
+     *
+     * The Invoice and the buyer email whose sent or failed outcome the event announces.
+     */
+    data: {
+        deliveryId: string;
+        id: string;
+        sourceConnectionId: string;
+    };
+    type: "invoice.deliverySent";
+} | {
+    /**
+     * InvoiceDeliveryEventData
+     *
+     * The Invoice and the buyer email whose sent or failed outcome the event announces.
+     */
+    data: {
+        deliveryId: string;
+        id: string;
+        sourceConnectionId: string;
+    };
+    type: "invoice.deliveryFailed";
 };
 export type InvoiceWebhookEventEnvelope = {
     apiVersion: string;
@@ -1974,6 +1997,44 @@ export type InvoiceWebhookEventEnvelope = {
     organizationId: string;
     sequence: string;
     type: "invoice.ready";
+} | {
+    apiVersion: string;
+    /**
+     * InvoiceDeliveryEventData
+     *
+     * The Invoice and the buyer email whose sent or failed outcome the event announces.
+     */
+    data: {
+        deliveryId: string;
+        id: string;
+        sourceConnectionId: string;
+    };
+    environment: FiscalEnvironment;
+    id: string;
+    object: WebhookEventObject;
+    occurredAt: string;
+    organizationId: string;
+    sequence: string;
+    type: "invoice.deliverySent";
+} | {
+    apiVersion: string;
+    /**
+     * InvoiceDeliveryEventData
+     *
+     * The Invoice and the buyer email whose sent or failed outcome the event announces.
+     */
+    data: {
+        deliveryId: string;
+        id: string;
+        sourceConnectionId: string;
+    };
+    environment: FiscalEnvironment;
+    id: string;
+    object: WebhookEventObject;
+    occurredAt: string;
+    organizationId: string;
+    sequence: string;
+    type: "invoice.deliveryFailed";
 };
 export type InvoiceXmlReadiness = {
     status: "notApplicable";
@@ -1990,6 +2051,19 @@ export type InvoiceXmlReadiness = {
  * One stable reason the authoritative rules refuse to issue.
  */
 export type IssuanceBlocker = "invalid_request" | "unsupported_protocol" | "unsupported_rules_version" | "invalid_resolved_facts" | "numbering_verifier_missing" | "numbering_mode_not_enabled" | "document_type_not_recognized" | "authorization_missing" | "authorization_not_observed_on_effective_date" | "authorization_suspended" | "authorization_cancelled" | "authorization_superseded" | "authorization_exhausted" | "authorization_conflicting" | "authorization_document_type_mismatch" | "central_assignment_requires_verified_authorization" | "authorization_expired" | "authorization_range_overlap" | "fiscal_number_capacity_exhausted" | "invalid_fiscal_number" | "fiscal_number_outside_authorized_range" | "fiscal_number_before_verified_floor" | "sequence_expiration_mismatch";
+/**
+ * Whether the issuer can issue each e-CF type now in this environment.
+ */
+export type IssuanceReadiness = {
+    certificate: SigningCertificateReadiness;
+    /**
+     * Every e-CF type, in type order.
+     */
+    documentTypes: Array<DocumentTypeIssuanceReadiness>;
+    environment: FiscalEnvironment;
+    issuerTaxId: string;
+};
+export type IssuanceReadinessReason = "legal_issuer_profile_incomplete" | "signing_certificate_missing" | "signing_certificate_expired" | "signing_certificate_not_yet_valid" | "authorization_missing" | "authorization_not_active" | "authorization_not_verified" | "authorization_not_observed" | "range_exhausted" | "authorization_expiration_invalid" | "authorization_expired" | "authorization_range_overlap";
 export type LedgerCounter = string;
 export type LegalIssuer = {
     address: string | null;
@@ -2059,6 +2133,19 @@ export type NumberedFiscalDocument = {
     fiscal_number: string;
     sequence_expires_on: string | null;
 };
+/**
+ * The range Timbro assigns the next fiscal number of this type from.
+ */
+export type NumberingRange = {
+    /**
+     * The sequence expiry, or `null` for a type without one (E32 and E34).
+     */
+    expiresOn: string | null;
+    /**
+     * Fiscal numbers left in the selected range.
+     */
+    remaining: number;
+};
 export type OnboardingLegalIssuerIdentity = {
     object: OnboardingLegalIssuerIdentityResourceObject;
     outcome: OnboardingLegalIssuerIdentityOutcome;
@@ -2493,6 +2580,27 @@ export type SignedDocumentReadinessResource = {
     sha256: string;
     status: "ready";
 };
+/**
+ * The active signing certificate, judged at the moment of the read.
+ */
+export type SigningCertificateReadiness = {
+    notAfter: string;
+    notBefore: string;
+    sha256: string;
+    status: "ready";
+} | {
+    notAfter: string;
+    notBefore: string;
+    sha256: string;
+    status: "expired";
+} | {
+    notAfter: string;
+    notBefore: string;
+    sha256: string;
+    status: "notYetValid";
+} | {
+    status: "missing";
+};
 /**
  * Named additional taxes supported by the common Source contract.
  */
@@ -4202,6 +4310,44 @@ export type WebhookEventEnvelope = {
     organizationId: string;
     sequence: string;
     type: "invoice.ready";
+} | {
+    apiVersion: string;
+    /**
+     * InvoiceDeliveryEventData
+     *
+     * The Invoice and the buyer email whose sent or failed outcome the event announces.
+     */
+    data: {
+        deliveryId: string;
+        id: string;
+        sourceConnectionId: string;
+    };
+    environment: FiscalEnvironment;
+    id: string;
+    object: WebhookEventObject;
+    occurredAt: string;
+    organizationId: string;
+    sequence: string;
+    type: "invoice.deliverySent";
+} | {
+    apiVersion: string;
+    /**
+     * InvoiceDeliveryEventData
+     *
+     * The Invoice and the buyer email whose sent or failed outcome the event announces.
+     */
+    data: {
+        deliveryId: string;
+        id: string;
+        sourceConnectionId: string;
+    };
+    environment: FiscalEnvironment;
+    id: string;
+    object: WebhookEventObject;
+    occurredAt: string;
+    organizationId: string;
+    sequence: string;
+    type: "invoice.deliveryFailed";
 } | {
     apiVersion: string;
     data: {
@@ -4980,6 +5126,45 @@ export type ReplaceHostedInvoiceResponses = {
     201: InvoiceResource;
 };
 export type ReplaceHostedInvoiceResponse = ReplaceHostedInvoiceResponses[keyof ReplaceHostedInvoiceResponses];
+export type RetrieveHostedIssuanceReadinessData = {
+    body?: never | undefined;
+    path?: never | undefined;
+    query: {
+        checkout_tenant_id: string;
+        environment: FiscalEnvironment;
+    };
+    url: "/internal/hosted/issuance-readiness";
+};
+export type RetrieveHostedIssuanceReadinessErrors = {
+    /**
+     * The hosted tenant coordinates are invalid.
+     */
+    400: ProblemBody;
+    /**
+     * The service credential is missing, revoked, or invalid.
+     */
+    401: ProblemBody;
+    /**
+     * The hosted tenant has no binding in this environment.
+     */
+    404: ProblemBody;
+    /**
+     * The native stamp server returned a typed Problem.
+     */
+    409: ProblemBody;
+    /**
+     * The native stamp server returned a typed Problem.
+     */
+    500: ProblemBody;
+};
+export type RetrieveHostedIssuanceReadinessError = RetrieveHostedIssuanceReadinessErrors[keyof RetrieveHostedIssuanceReadinessErrors];
+export type RetrieveHostedIssuanceReadinessResponses = {
+    /**
+     * Whether the hosted tenant's issuer can issue each e-CF type now in this environment.
+     */
+    200: IssuanceReadiness;
+};
+export type RetrieveHostedIssuanceReadinessResponse = RetrieveHostedIssuanceReadinessResponses[keyof RetrieveHostedIssuanceReadinessResponses];
 export type ListFiscalOperationsData = {
     body?: never | undefined;
     path?: never | undefined;
@@ -5289,38 +5474,6 @@ export type ReadFiscalOperationTimingResponses = {
     200: FiscalOperationTimingReport;
 };
 export type ReadFiscalOperationTimingResponse = ReadFiscalOperationTimingResponses[keyof ReadFiscalOperationTimingResponses];
-export type ReadCertificateCustodyReadinessData = {
-    body?: never | undefined;
-    path?: never | undefined;
-    query?: never | undefined;
-    url: "/v1/certificate-custody/readiness";
-};
-export type ReadCertificateCustodyReadinessErrors = {
-    /**
-     * The Source connection credential is missing, invalid, or revoked.
-     */
-    401: ProblemBody;
-    /**
-     * The Source connection is not authorized to read this Fiscal operation.
-     */
-    403: ProblemBody;
-    /**
-     * The native stamp server returned a typed Problem.
-     */
-    409: ProblemBody;
-    /**
-     * The native stamp server returned a typed Problem.
-     */
-    500: ProblemBody;
-};
-export type ReadCertificateCustodyReadinessError = ReadCertificateCustodyReadinessErrors[keyof ReadCertificateCustodyReadinessErrors];
-export type ReadCertificateCustodyReadinessResponses = {
-    /**
-     * The authenticated tenant's certificate-custody readiness resource.
-     */
-    200: CertificateCustodyReadiness;
-};
-export type ReadCertificateCustodyReadinessResponse = ReadCertificateCustodyReadinessResponses[keyof ReadCertificateCustodyReadinessResponses];
 export type CreateDirectConnectionRequestData = {
     body: CreateDirectConnectionRequest;
     path?: never | undefined;
@@ -5487,38 +5640,6 @@ export type RetrieveFiscalDeliveryPrintedRepresentationResponses = {
     200: Uint8Array;
 };
 export type RetrieveFiscalDeliveryPrintedRepresentationResponse = RetrieveFiscalDeliveryPrintedRepresentationResponses[keyof RetrieveFiscalDeliveryPrintedRepresentationResponses];
-export type ReadFiscalNumberAuthorizationReadinessData = {
-    body?: never | undefined;
-    path?: never | undefined;
-    query?: never | undefined;
-    url: "/v1/fiscal-number-authorizations/readiness";
-};
-export type ReadFiscalNumberAuthorizationReadinessErrors = {
-    /**
-     * The Source connection credential is missing, invalid, or revoked.
-     */
-    401: ProblemBody;
-    /**
-     * The Source connection is not authorized to read fiscal-number readiness.
-     */
-    403: ProblemBody;
-    /**
-     * The native stamp server returned a typed Problem.
-     */
-    409: ProblemBody;
-    /**
-     * The native stamp server returned a typed Problem.
-     */
-    500: ProblemBody;
-};
-export type ReadFiscalNumberAuthorizationReadinessError = ReadFiscalNumberAuthorizationReadinessErrors[keyof ReadFiscalNumberAuthorizationReadinessErrors];
-export type ReadFiscalNumberAuthorizationReadinessResponses = {
-    /**
-     * Current central fiscal-number ranges and actionable availability for the authenticated Source connection's issuer and environment.
-     */
-    200: FiscalNumberAuthorizationReadiness;
-};
-export type ReadFiscalNumberAuthorizationReadinessResponse = ReadFiscalNumberAuthorizationReadinessResponses[keyof ReadFiscalNumberAuthorizationReadinessResponses];
 export type ImportHostedCertificateCustodyData = {
     body: HostedImportRequest;
     path?: never | undefined;
@@ -6189,6 +6310,34 @@ export type ReplaceInvoiceResponses = {
     201: InvoiceResource;
 };
 export type ReplaceInvoiceResponse = ReplaceInvoiceResponses[keyof ReplaceInvoiceResponses];
+export type RetrieveIssuanceReadinessData = {
+    body?: never | undefined;
+    path?: never | undefined;
+    query?: never | undefined;
+    url: "/v1/issuance-readiness";
+};
+export type RetrieveIssuanceReadinessErrors = {
+    /**
+     * The Source connection credential is missing, invalid, or revoked.
+     */
+    401: ProblemBody;
+    /**
+     * The Source connection is not connected.
+     */
+    409: ProblemBody;
+    /**
+     * The native stamp server returned a typed Problem.
+     */
+    500: ProblemBody;
+};
+export type RetrieveIssuanceReadinessError = RetrieveIssuanceReadinessErrors[keyof RetrieveIssuanceReadinessErrors];
+export type RetrieveIssuanceReadinessResponses = {
+    /**
+     * Whether the Source connection's issuer can issue each e-CF type now, with every blocking reason.
+     */
+    200: IssuanceReadiness;
+};
+export type RetrieveIssuanceReadinessResponse = RetrieveIssuanceReadinessResponses[keyof RetrieveIssuanceReadinessResponses];
 export type ReadOpenApiDocumentData = {
     body?: never | undefined;
     path?: never | undefined;