@timbro/invoices 0.13.0 → 0.14.0

package/dist/generated/invoice-api-contract.d.ts

@@ -2114,8 +2114,7 @@ export declare const invoiceApiContract: {
                         readonly $ref: "#/components/schemas/InvoiceTax";
                     };
                     readonly unit: {
-                        readonly type: "string";
-                        readonly description: "A named common unit, or the retained DGII code for another official unit.";
+                        readonly $ref: "#/components/schemas/SourceMeasurementUnit";
                     };
                     readonly unitPrice: {
                         readonly type: "string";
@@ -2279,6 +2278,11 @@ export declare const invoiceApiContract: {
                     readonly propertyName: "kind";
                 };
             };
+            readonly SourceMeasurementUnit: {
+                readonly type: "string";
+                readonly description: "A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire,\nthe official numeric catalog code in fiscal documents.";
+                readonly enum: readonly ["barrel", "bag", "jar", "bundle", "bottle", "box", "cigarette_pack", "centimetre", "cylinder", "set", "container", "day", "dozen", "bale", "gallon", "degree", "gram", "bulk", "hour", "crate", "kilogram", "kilowatt_hour", "pound", "litre", "lot", "metre", "square_metre", "cubic_metre", "million_btu", "minute", "package", "pair", "foot", "piece", "roll", "envelope", "second", "tank", "ton", "tube", "yard", "square_yard", "unit", "element", "thousand", "sack", "tin", "display", "drum", "ration", "quintal", "gross_register_tonnage", "square_foot", "passenger", "inch", "boat_berth_stay", "tray", "hectare", "millilitre", "milligram", "ounce", "troy_ounce"];
+            };
             readonly InvoiceItemWithholding: {
                 readonly oneOf: readonly [{
                     readonly type: "object";
@@ -2604,7 +2608,7 @@ export declare const invoiceApiContract: {
             readonly IssuanceBlocker: {
                 readonly type: "string";
                 readonly description: "One stable reason the authoritative rules refuse to issue.";
-                readonly enum: readonly ["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"];
+                readonly enum: readonly ["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", "sequence_rejected_by_dgii", "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"];
             };
             readonly FiscalAdmissionProblem: {
                 readonly type: "object";
@@ -5204,7 +5208,7 @@ export declare const invoiceApiContract: {
                     readonly additionalProperties: false;
                 }, {
                     readonly type: "object";
-                    readonly required: readonly ["invoiceReference", "currency", "paymentTerms", "items", "originalInvoiceId", "modificationCode", "reason", "type"];
+                    readonly required: readonly ["invoiceReference", "currency", "paymentTerms", "items", "modificationCode", "reason", "originalInvoiceId", "type"];
                     readonly properties: {
                         readonly additionalInformation: {
                             readonly oneOf: readonly [{
@@ -5264,6 +5268,99 @@ export declare const invoiceApiContract: {
                         readonly originalInvoiceId: {
                             readonly type: "string";
                             readonly format: "uuid";
+                            readonly description: "The Invoice Timbro issued that this note modifies. The note takes its buyer from that Invoice.";
+                        };
+                        readonly paymentTerms: {
+                            readonly $ref: "#/components/schemas/InvoicePaymentTerms";
+                        };
+                        readonly pdfLayout: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoicePdfLayout";
+                            }];
+                        };
+                        readonly reason: {
+                            readonly type: "string";
+                            readonly maxLength: 90;
+                            readonly minLength: 1;
+                            readonly pattern: "^[^\\p{White_Space}](?:[\\s\\S]*[^\\p{White_Space}])?$";
+                            readonly "x-timbro-submission-validation": readonly ["minLength", "maxLength", "pattern"];
+                        };
+                        readonly source: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoiceSourceInput";
+                            }];
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["E33"];
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }, {
+                    readonly type: "object";
+                    readonly required: readonly ["invoiceReference", "currency", "paymentTerms", "items", "modificationCode", "reason", "externalOriginal", "type"];
+                    readonly properties: {
+                        readonly additionalInformation: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoiceAdditionalInformation";
+                            }];
+                        };
+                        readonly currency: {
+                            readonly type: "string";
+                            readonly enum: readonly ["DOP"];
+                            readonly "x-timbro-submission-validation": readonly ["enum"];
+                        };
+                        readonly expectedTotals: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoiceExpectedTotals";
+                            }];
+                        };
+                        readonly externalOriginal: {
+                            readonly $ref: "#/components/schemas/InvoiceExternalOriginal";
+                        };
+                        readonly incomeType: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly type: "string";
+                                readonly enum: readonly ["01", "02", "03", "04", "05", "06"];
+                                readonly "x-timbro-submission-validation": readonly ["enum"];
+                            }];
+                        };
+                        readonly invoiceReference: {
+                            readonly type: "string";
+                            readonly description: "The only field a source-system reference travels in, bounded at 128 characters.";
+                            readonly maxLength: 128;
+                            readonly minLength: 1;
+                            readonly pattern: "^[^\\p{White_Space}](?:[\\s\\S]*[^\\p{White_Space}])?$";
+                            readonly "x-timbro-submission-validation": readonly ["minLength", "maxLength", "pattern"];
+                        };
+                        readonly items: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly $ref: "#/components/schemas/InvoiceItem";
+                            };
+                            readonly maxItems: 1000;
+                            readonly minItems: 1;
+                            readonly "x-timbro-submission-validation": readonly ["minItems", "maxItems"];
+                        };
+                        readonly modificationCode: {
+                            readonly $ref: "#/components/schemas/InvoiceDebitNoteModificationCode";
+                        };
+                        readonly numbering: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoiceNumbering";
+                            }];
                         };
                         readonly paymentTerms: {
                             readonly $ref: "#/components/schemas/InvoicePaymentTerms";
@@ -5297,7 +5394,7 @@ export declare const invoiceApiContract: {
                     readonly additionalProperties: false;
                 }, {
                     readonly type: "object";
-                    readonly required: readonly ["invoiceReference", "currency", "paymentTerms", "items", "originalInvoiceId", "modificationCode", "reason", "type"];
+                    readonly required: readonly ["invoiceReference", "currency", "paymentTerms", "items", "modificationCode", "reason", "originalInvoiceId", "type"];
                     readonly properties: {
                         readonly additionalInformation: {
                             readonly oneOf: readonly [{
@@ -5357,6 +5454,99 @@ export declare const invoiceApiContract: {
                         readonly originalInvoiceId: {
                             readonly type: "string";
                             readonly format: "uuid";
+                            readonly description: "The Invoice Timbro issued that this note modifies. The note takes its buyer from that Invoice.";
+                        };
+                        readonly paymentTerms: {
+                            readonly $ref: "#/components/schemas/InvoiceCreditNotePaymentTerms";
+                        };
+                        readonly pdfLayout: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoicePdfLayout";
+                            }];
+                        };
+                        readonly reason: {
+                            readonly type: "string";
+                            readonly maxLength: 90;
+                            readonly minLength: 1;
+                            readonly pattern: "^[^\\p{White_Space}](?:[\\s\\S]*[^\\p{White_Space}])?$";
+                            readonly "x-timbro-submission-validation": readonly ["minLength", "maxLength", "pattern"];
+                        };
+                        readonly source: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoiceSourceInput";
+                            }];
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["E34"];
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }, {
+                    readonly type: "object";
+                    readonly required: readonly ["invoiceReference", "currency", "paymentTerms", "items", "modificationCode", "reason", "externalOriginal", "type"];
+                    readonly properties: {
+                        readonly additionalInformation: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoiceAdditionalInformation";
+                            }];
+                        };
+                        readonly currency: {
+                            readonly type: "string";
+                            readonly enum: readonly ["DOP"];
+                            readonly "x-timbro-submission-validation": readonly ["enum"];
+                        };
+                        readonly expectedTotals: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoiceExpectedTotals";
+                            }];
+                        };
+                        readonly externalOriginal: {
+                            readonly $ref: "#/components/schemas/InvoiceExternalOriginal";
+                        };
+                        readonly incomeType: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly type: "string";
+                                readonly enum: readonly ["01", "02", "03", "04", "05", "06"];
+                                readonly "x-timbro-submission-validation": readonly ["enum"];
+                            }];
+                        };
+                        readonly invoiceReference: {
+                            readonly type: "string";
+                            readonly description: "The only field a source-system reference travels in, bounded at 128 characters.";
+                            readonly maxLength: 128;
+                            readonly minLength: 1;
+                            readonly pattern: "^[^\\p{White_Space}](?:[\\s\\S]*[^\\p{White_Space}])?$";
+                            readonly "x-timbro-submission-validation": readonly ["minLength", "maxLength", "pattern"];
+                        };
+                        readonly items: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly $ref: "#/components/schemas/InvoiceItem";
+                            };
+                            readonly maxItems: 10000;
+                            readonly minItems: 1;
+                            readonly "x-timbro-submission-validation": readonly ["minItems", "maxItems"];
+                        };
+                        readonly modificationCode: {
+                            readonly $ref: "#/components/schemas/InvoiceCreditNoteModificationCode";
+                        };
+                        readonly numbering: {
+                            readonly oneOf: readonly [{
+                                readonly type: "null";
+                            }, {
+                                readonly $ref: "#/components/schemas/InvoiceNumbering";
+                            }];
                         };
                         readonly paymentTerms: {
                             readonly $ref: "#/components/schemas/InvoiceCreditNotePaymentTerms";
@@ -5389,9 +5579,6 @@ export declare const invoiceApiContract: {
                     };
                     readonly additionalProperties: false;
                 }];
-                readonly discriminator: {
-                    readonly propertyName: "type";
-                };
             };
             readonly InvoiceAdditionalInformation: {
                 readonly type: "object";
@@ -5820,11 +6007,6 @@ export declare const invoiceApiContract: {
                 };
                 readonly additionalProperties: false;
             };
-            readonly SourceMeasurementUnit: {
-                readonly type: "string";
-                readonly description: "Common semantic measurement units mapped to official DGII catalog codes by fiscal-document.";
-                readonly enum: readonly ["unit", "kilogram", "litre", "metre", "piece"];
-            };
             readonly InvoiceNumbering: {
                 readonly type: "object";
                 readonly required: readonly ["eNcf"];
@@ -7012,6 +7194,53 @@ export declare const invoiceApiContract: {
                 readonly type: "string";
                 readonly enum: readonly ["2", "3"];
             };
+            readonly InvoiceExternalOriginal: {
+                readonly type: "object";
+                readonly description: "A document issued outside Timbro that a legal note modifies.\n\n`fiscalNumber` is the original e-NCF (`E`, the two type digits, and ten digits) or paper NCF\n(`B` and ten digits, or `A` or `P` and eighteen digits). `issuerTaxId` is DGII's RNC Otro\nContribuyente and applies only when the original was issued under a different RNC than the\nnote, for example after a merger or split. `buyer` is the original's buyer and may be omitted\nfor an anonymous consumer document. `total` is the original's total and is required when the\noriginal is an e-CF type 32, because DGII requires the buyer's identity on a note against a\ntype 32 of DOP 250,000.00 or more.";
+                readonly required: readonly ["fiscalNumber", "issuedOn"];
+                readonly properties: {
+                    readonly buyer: {
+                        readonly oneOf: readonly [{
+                            readonly type: "null";
+                        }, {
+                            readonly $ref: "#/components/schemas/InvoiceConsumerBuyer";
+                        }];
+                    };
+                    readonly fiscalNumber: {
+                        readonly type: "string";
+                        readonly pattern: "^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$";
+                        readonly "x-timbro-submission-validation": readonly ["pattern"];
+                    };
+                    readonly issuedOn: {
+                        readonly $ref: "#/components/schemas/InvoiceDate";
+                    };
+                    readonly issuerTaxId: {
+                        readonly oneOf: readonly [{
+                            readonly type: "null";
+                        }, {
+                            readonly type: "string";
+                            readonly pattern: "^[0-9]{9}([0-9]{2})?$";
+                            readonly "x-timbro-submission-validation": readonly ["pattern"];
+                        }];
+                    };
+                    readonly total: {
+                        readonly oneOf: readonly [{
+                            readonly type: "null";
+                        }, {
+                            readonly type: "string";
+                            readonly pattern: "^[0-9]{1,16}(\\.[0-9]{1,2})?$";
+                            readonly "x-timbro-submission-validation": readonly ["pattern"];
+                        }];
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+            readonly InvoiceDate: {
+                readonly type: "string";
+                readonly format: "date";
+                readonly description: "A calendar date in the public API's ISO 8601 date form.";
+                readonly pattern: "^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$";
+            };
             readonly InvoiceCreditNoteModificationCode: {
                 readonly type: "string";
                 readonly enum: readonly ["1", "2", "3"];