@peable.to/contracts 0.4.0 → 1.0.0

package/dist/cjs/resources/tax/registrationDeclarations.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxRegistrationDeclarationRoutes = exports.listTaxRegistrationDeclarationsQuery = exports.updateTaxRegistrationDeclarationParams = exports.createTaxRegistrationDeclarationParams = exports.taxRegistrationDeclarationSchema = exports.taxDeclarationVerificationSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/** No authority integration confirms anything yet: every declaration is `unverified`. */
+exports.taxDeclarationVerificationSchema = (0, objects_1.defineComponent)('TaxRegistrationDeclarationVerification', zod_1.z
+    .object({
+    status: zod_1.z.literal('unverified'),
+    reason: zod_1.z.literal('no_authority_integration'),
+})
+    .strict());
+/**
+ * A declared registration status (`taxrd_…`): where the business stands with a
+ * tax authority, IN ITS OWN WORDS. Storing one is NOT registration with a
+ * government, and it never makes Peable collect: collection needs a Peable Tax
+ * registration (`taxreg_…`) the owner approved.
+ */
+exports.taxRegistrationDeclarationSchema = (0, objects_1.defineObject)('tax.registration_declaration', 'TaxRegistrationDeclaration', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.registration_declaration'),
+    id: zod_1.z.string().describe('`taxrd_…`.'),
+    livemode: primitives_1.livemode,
+    country: shared_1.taxCountry,
+    state: shared_1.taxState,
+    scheme: zod_1.z
+        .enum(tax_1.TAX_REGISTRATION_SCHEMES)
+        .nullable()
+        .describe('The scheme, when the owner knows it; `null` for `unknown`.'),
+    status: zod_1.z.enum(tax_1.TAX_REGISTRATION_DECLARATION_STATUSES),
+    effective_from: primitives_1.unixSeconds.nullable(),
+    effective_to: primitives_1.unixSeconds.nullable(),
+    filing_frequency: zod_1.z.enum(tax_1.TAX_FILING_FREQUENCIES),
+    collection_registration: primitives_1.nullableString.describe('The Peable Tax collection registration (`taxreg_…`) it corresponds to, when there is one.'),
+    verification: exports.taxDeclarationVerificationSchema,
+    note: primitives_1.nullableString,
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+    updated: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.registration_declaration',
+            id: 'taxrd_0193b8f2c1a87d3e9f4a',
+            livemode: false,
+            country: 'ES',
+            state: null,
+            scheme: 'eu_oss_union',
+            status: 'registered',
+            effective_from: 1767225600,
+            effective_to: null,
+            filing_frequency: 'quarterly',
+            collection_registration: 'taxreg_0193b8f2c1a87d3e9f4a',
+            verification: { status: 'unverified', reason: 'no_authority_integration' },
+            note: null,
+            metadata: {},
+            created: 1793750400,
+            updated: 1793750400,
+        },
+    ],
+});
+const declarationFields = {
+    scheme: zod_1.z.enum(tax_1.TAX_REGISTRATION_SCHEMES).nullable().optional(),
+    status: zod_1.z.enum(tax_1.TAX_REGISTRATION_DECLARATION_STATUSES),
+    effective_from: shared_1.taxInstantParam.nullable().optional(),
+    effective_to: shared_1.taxInstantParam.nullable().optional(),
+    filing_frequency: zod_1.z.enum(tax_1.TAX_FILING_FREQUENCIES).optional(),
+    collection_registration: shared_1.complianceIdParam.nullable().optional(),
+    note: (0, shared_1.complianceTextParam)(1000).optional(),
+};
+/** Orbit's new declaration (the owner's). */
+exports.createTaxRegistrationDeclarationParams = zod_1.z
+    .object({
+    country: shared_1.complianceCountryParam,
+    state: shared_1.complianceStateParam.optional(),
+    ...declarationFields,
+    metadata: params_1.metadataCreateParam.optional(),
+})
+    .strict();
+/** Orbit's update (the owner's): the place is fixed; `metadata` is a patch. */
+exports.updateTaxRegistrationDeclarationParams = zod_1.z
+    .object({
+    ...declarationFields,
+    status: declarationFields.status.optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+})
+    .strict();
+exports.listTaxRegistrationDeclarationsQuery = (0, params_1.listQuery)({});
+exports.taxRegistrationDeclarationRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listTaxRegistrationDeclarations',
+        method: 'get',
+        path: '/v1/tax/registration_declarations',
+        tag: 'Tax compliance',
+        summary: 'List registration declarations',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listTaxRegistrationDeclarationsQuery,
+        response: (0, envelopes_1.listOf)(exports.taxRegistrationDeclarationSchema),
+        sdk: 'tax.compliance.listRegistrationDeclarations',
+        expandable: 'tax.registration_declaration',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxRegistrationDeclaration',
+        method: 'get',
+        path: '/v1/tax/registration_declarations/{id}',
+        tag: 'Tax compliance',
+        summary: 'Retrieve a registration declaration',
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: 'The declaration (`taxrd_…`).' },
+        query: params_1.expandOnlyQuery,
+        response: exports.taxRegistrationDeclarationSchema,
+        sdk: 'tax.compliance.retrieveRegistrationDeclaration',
+        expandable: 'tax.registration_declaration',
+    }),
+];

package/dist/cjs/resources/tax/registrations.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxRegistrationRoutes = exports.endTaxRegistrationParams = exports.createTaxRegistrationParams = exports.taxRegistrationSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/**
+ * A Peable Tax registration (`taxreg_…`, ADR 0011): where the seller says it
+ * is registered to collect. Only registrations the owner approved make Peable
+ * collect. Registering with a government is the seller's job, never Peable's.
+ */
+exports.taxRegistrationSchema = (0, objects_1.defineObject)('tax.registration', 'TaxRegistration', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.registration'),
+    id: zod_1.z.string().describe('`taxreg_…`.'),
+    country: shared_1.taxCountry,
+    state: shared_1.taxState,
+    scheme: zod_1.z.enum(tax_1.TAX_REGISTRATION_SCHEMES),
+    registration_number: primitives_1.nullableString.describe('The government-issued number (VAT id, state permit), when there is one.'),
+    active_from: primitives_1.unixSeconds,
+    expires_at: primitives_1.unixSeconds.nullable(),
+    status: zod_1.z
+        .enum(tax_1.TAX_REGISTRATION_STATUSES)
+        .describe('`pending_approval` until the owner approves; `scheduled` before `active_from`.'),
+    approved_at: primitives_1.unixSeconds.nullable(),
+    provider_registration_ref: primitives_1.nullableString.describe('The mirrored registration at the calculating provider, once synced.'),
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.registration',
+            id: 'taxreg_0193b8f2c1a87d3e9f4a',
+            country: 'ES',
+            state: null,
+            scheme: 'eu_oss_union',
+            registration_number: 'ESB12345678',
+            active_from: 1793750400,
+            expires_at: null,
+            status: 'active',
+            approved_at: 1793750400,
+            provider_registration_ref: 'taxreg_1QxYz2AbCdEf',
+            created: 1793664000,
+        },
+    ],
+});
+/** Orbit's new registration (the owner's): pending until the owner approves. */
+exports.createTaxRegistrationParams = zod_1.z
+    .object({
+    country: zod_1.z.string().regex(/^[A-Z]{2}$/),
+    state: zod_1.z
+        .string()
+        .regex(/^[A-Z0-9]{1,3}$/)
+        .nullish(),
+    scheme: zod_1.z.enum(tax_1.TAX_REGISTRATION_SCHEMES),
+    registration_number: zod_1.z.string().trim().min(1).max(64).nullish(),
+    active_from: shared_1.taxInstantParam
+        .optional()
+        .describe('Unix seconds; omitted means immediately on approval.'),
+    expires_at: shared_1.taxInstantParam.nullish(),
+})
+    .strict();
+/** Orbit's end of a registration at `expires_at`. */
+exports.endTaxRegistrationParams = zod_1.z.object({ expires_at: shared_1.taxInstantParam }).strict();
+exports.taxRegistrationRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listTaxRegistrations',
+        method: 'get',
+        path: '/v1/tax/registrations',
+        tag: 'Tax',
+        summary: 'List tax registrations',
+        description: 'Every registration of the merchant, oldest first: a complete list, `has_more` is `false`. Registrations are added and approved by the owner in Orbit.',
+        auth: 'service',
+        scope: 'payments:read',
+        response: (0, envelopes_1.listOf)(exports.taxRegistrationSchema),
+        sdk: 'tax.listRegistrations',
+    }),
+];

package/dist/cjs/resources/tax/reports.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxReportRoutes = exports.taxReportQuery = exports.taxReportSchema = exports.taxReportRowSchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/**
+ * The Peable Tax summary report: totals per jurisdiction, registration, tax
+ * type and rate — the lines a return (an OSS return, a state filing) is
+ * prepared from. A report is not a filed return.
+ */
+/** One filing line. Reversals are netted in: `taxable_amount` and `tax_amount` are net. */
+exports.taxReportRowSchema = (0, objects_1.defineComponent)('TaxReportRow', zod_1.z
+    .object({
+    country: shared_1.taxCountry,
+    state: shared_1.taxState,
+    registration_id: primitives_1.nullableString.describe('The registration (`taxreg_…`) that collected.'),
+    scheme: zod_1.z.enum(tax_1.TAX_REGISTRATION_SCHEMES).nullable(),
+    collection: zod_1.z.enum(tax_1.TAX_COLLECTIONS),
+    tax_type: primitives_1.nullableString,
+    rate_percentage: primitives_1.nullableString.describe('Decimal string, e.g. `"20.0"`.'),
+    currency: zod_1.z.string().describe('Uppercase ISO 4217.'),
+    transactions: zod_1.z.number().int().nonnegative(),
+    reversals: zod_1.z.number().int().nonnegative().describe('Reversals netted into this row.'),
+    taxable_amount: shared_1.taxMinorAmount,
+    tax_amount: shared_1.taxMinorAmount,
+})
+    .strict());
+exports.taxReportSchema = (0, objects_1.defineObject)('tax.report', 'TaxReport', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.report'),
+    from: primitives_1.unixSeconds.describe('Inclusive.'),
+    to: primitives_1.unixSeconds.describe('Exclusive.'),
+    rows: zod_1.z.array(exports.taxReportRowSchema),
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.report',
+            from: 1790812800,
+            to: 1798761600,
+            rows: [
+                {
+                    country: 'DE',
+                    state: null,
+                    registration_id: 'taxreg_0193b8f2c1a87d3e9f4a',
+                    scheme: 'eu_oss_union',
+                    collection: 'collect',
+                    tax_type: 'vat',
+                    rate_percentage: '19.0',
+                    currency: 'EUR',
+                    transactions: 42,
+                    reversals: 1,
+                    taxable_amount: 41000,
+                    tax_amount: 7790,
+                },
+            ],
+        },
+    ],
+});
+/** The filing window: `from` inclusive, `to` exclusive, Unix seconds. */
+exports.taxReportQuery = zod_1.z
+    .object({
+    // Not `.describe()`d: a described copy would lose the integer spelling the
+    // OpenAPI document gives `queryUnixSeconds`. The route says what they mean.
+    from: params_1.queryUnixSeconds,
+    to: params_1.queryUnixSeconds,
+    format: zod_1.z
+        .enum(['json', 'csv'])
+        .optional()
+        .describe('`csv` answers the rows as a `text/csv` attachment (a filing export) instead of JSON.'),
+})
+    .strict();
+exports.taxReportRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxReportSummary',
+        method: 'get',
+        path: '/v1/tax/reports/summary',
+        tag: 'Tax',
+        summary: 'Summarize collected tax',
+        description: 'Totals per jurisdiction, registration, tax type and rate over `[from, to)` (Unix seconds, `from` inclusive, `to` exclusive, on `committed_at`), reversals netted in. With `format=csv`, the same rows as a `text/csv` attachment.',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.taxReportQuery,
+        response: exports.taxReportSchema,
+        sdk: 'tax.reports.summary',
+    }),
+];

package/dist/cjs/resources/tax/reviewItems.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxReviewItemRoutes = exports.listTaxReviewItemsQuery = exports.resolveTaxReviewItemParams = exports.taxReviewItemSchema = exports.taxReviewDecisionSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/** The owner's recorded decision, with who and when. */
+exports.taxReviewDecisionSchema = (0, objects_1.defineComponent)('TaxReviewDecision', zod_1.z
+    .object({
+    decision: zod_1.z.enum(tax_1.TAX_REVIEW_DECISIONS),
+    note: primitives_1.nullableString,
+    decided_by: zod_1.z.string().describe('The Oxy user who decided.'),
+    decided_at: primitives_1.unixSeconds,
+})
+    .strict());
+/**
+ * A finding that needs a person (`taxrev_…`): opened by an assessment, kept
+ * open while later ones find it again, and closed only by the owner's
+ * decision in Orbit. No decision activates collection.
+ */
+exports.taxReviewItemSchema = (0, objects_1.defineObject)('tax.review_item', 'TaxReviewItem', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.review_item'),
+    id: zod_1.z.string().describe('`taxrev_…`.'),
+    livemode: primitives_1.livemode,
+    code: zod_1.z
+        .string()
+        .describe('Machine reason, e.g. `threshold_exceeded`, `registration_status_unknown`.'),
+    severity: zod_1.z.enum(tax_1.TAX_REVIEW_SEVERITIES),
+    status: zod_1.z.enum(tax_1.TAX_REVIEW_ITEM_STATUSES),
+    rule: primitives_1.nullableString,
+    country: primitives_1.nullableString,
+    state: shared_1.taxState,
+    message: zod_1.z.string(),
+    first_assessment: primitives_1.nullableString.describe('The assessment (`taxasm_…`) that opened it.'),
+    latest_assessment: primitives_1.nullableString.describe('The latest assessment (`taxasm_…`) that found it again.'),
+    decision: exports.taxReviewDecisionSchema.nullable(),
+    created: primitives_1.unixSeconds,
+    updated: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.review_item',
+            id: 'taxrev_0193b8f2c1a87d3e9f4a',
+            livemode: false,
+            code: 'threshold_approaching',
+            severity: 'review',
+            status: 'open',
+            rule: 'us_tx_sales_tax',
+            country: 'US',
+            state: 'TX',
+            message: 'Texas revenue is at or above 80% of the safe-harbor threshold.',
+            first_assessment: 'taxasm_0193b8f2c1a87d3e9f4a',
+            latest_assessment: 'taxasm_0193b8f2c1a87d3e9f4a',
+            decision: null,
+            created: 1793750400,
+            updated: 1793750400,
+        },
+    ],
+});
+/** Orbit's decision on an open item (the owner's, never a service credential's). */
+exports.resolveTaxReviewItemParams = zod_1.z
+    .object({
+    decision: zod_1.z.enum(tax_1.TAX_REVIEW_DECISIONS),
+    note: (0, shared_1.complianceTextParam)(1000)
+        .optional()
+        .describe("Required for `not_required` and `accepted_risk`: the owner's reason."),
+})
+    .strict()
+    .superRefine((input, ctx) => {
+    if ((input.decision === 'not_required' || input.decision === 'accepted_risk') && !input.note)
+        ctx.addIssue({
+            code: 'custom',
+            path: ['note'],
+            message: `a ${input.decision} decision records the owner's reason in note`,
+        });
+});
+exports.listTaxReviewItemsQuery = (0, params_1.listQuery)({
+    status: zod_1.z.enum(tax_1.TAX_REVIEW_ITEM_STATUSES).optional().describe('Only items in this status.'),
+});
+exports.taxReviewItemRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listTaxReviewItems',
+        method: 'get',
+        path: '/v1/tax/review_items',
+        tag: 'Tax compliance',
+        summary: 'List review items',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listTaxReviewItemsQuery,
+        response: (0, envelopes_1.listOf)(exports.taxReviewItemSchema),
+        sdk: 'tax.compliance.listReviewItems',
+        expandable: 'tax.review_item',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxReviewItem',
+        method: 'get',
+        path: '/v1/tax/review_items/{id}',
+        tag: 'Tax compliance',
+        summary: 'Retrieve a review item',
+        description: "Deciding an item is the owner's, in Orbit; a service credential only reads it.",
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: 'The review item (`taxrev_…`).' },
+        query: params_1.expandOnlyQuery,
+        response: exports.taxReviewItemSchema,
+        sdk: 'tax.compliance.retrieveReviewItem',
+        expandable: 'tax.review_item',
+    }),
+];

package/dist/cjs/resources/tax/ruleSet.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxRuleSetRoutes = exports.taxRuleSetSchema = exports.taxJurisdictionRuleSchema = exports.taxRuleThresholdSchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/**
+ * The jurisdiction rule set (ADR 0020): versioned CODE, not data a request can
+ * change. A version is immutable once published; an assessment stores the
+ * version it ran under and replays through the same one. Only the rules listed
+ * are supported; every other jurisdiction is `unsupported`, stated as such.
+ */
+exports.taxRuleThresholdSchema = (0, objects_1.defineComponent)('TaxRuleThreshold', zod_1.z
+    .object({
+    amount: primitives_1.amount,
+    currency: primitives_1.currency,
+    period: zod_1.z.enum(tax_1.TAX_THRESHOLD_PERIODS),
+})
+    .strict());
+/**
+ * One supported jurisdiction rule. `review.status` says whether a tax
+ * professional has signed it off — an `unreviewed` rule's findings always go
+ * to the review queue rather than standing on their own.
+ */
+exports.taxJurisdictionRuleSchema = (0, objects_1.defineObject)('tax.jurisdiction_rule', 'TaxJurisdictionRule', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.jurisdiction_rule'),
+    id: zod_1.z.string().describe('Stable, e.g. `eu_vat_b2c_cross_border`.'),
+    rule_set_version: zod_1.z.string(),
+    name: zod_1.z.string(),
+    tax_type: zod_1.z.enum(tax_1.TAX_TYPES),
+    countries: zod_1.z.array(zod_1.z.string()).describe('ISO 3166-1 alpha-2 codes the rule covers.'),
+    state: shared_1.taxState,
+    effective_from: primitives_1.unixSeconds,
+    threshold: exports.taxRuleThresholdSchema.nullable(),
+    sources: zod_1.z.array(shared_1.taxRuleSourceSchema),
+    coverage_limits: zod_1.z.array(shared_1.taxCoverageLimitSchema),
+    review: zod_1.z.object({ status: zod_1.z.enum(tax_1.TAX_RULE_REVIEW_STATUSES), note: zod_1.z.string() }).strict(),
+})
+    .strict());
+exports.taxRuleSetSchema = (0, objects_1.defineObject)('tax.rule_set', 'TaxRuleSet', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.rule_set'),
+    version: zod_1.z.string(),
+    published: primitives_1.unixSeconds,
+    rules: zod_1.z.array(exports.taxJurisdictionRuleSchema),
+    unsupported: zod_1.z
+        .string()
+        .describe('Everything not listed is `unsupported`, stated rather than implied.'),
+})
+    .strict());
+exports.taxRuleSetRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxRuleSet',
+        method: 'get',
+        path: '/v1/tax/rule_set',
+        tag: 'Tax compliance',
+        summary: 'Retrieve the current rule set',
+        description: 'The rules assessments currently run under, with their sources and limits.',
+        auth: 'service',
+        scope: 'payments:read',
+        response: exports.taxRuleSetSchema,
+        sdk: 'tax.compliance.retrieveRuleSet',
+    }),
+];

package/dist/cjs/resources/tax/salesDestinations.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxSalesDestinationRoutes = exports.listTaxSalesDestinationsQuery = exports.updateTaxSalesDestinationParams = exports.createTaxSalesDestinationParams = exports.taxSalesDestinationSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/**
+ * Where the business SAYS it sells (`taxdest_…`). Actual sales come from Peable
+ * Tax transactions; an assessment compares the two.
+ */
+exports.taxSalesDestinationSchema = (0, objects_1.defineObject)('tax.sales_destination', 'TaxSalesDestination', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.sales_destination'),
+    id: zod_1.z.string().describe('`taxdest_…`.'),
+    livemode: primitives_1.livemode,
+    country: shared_1.taxCountry,
+    state: shared_1.taxState,
+    customer_types: zod_1.z.enum(tax_1.TAX_CUSTOMER_TYPES),
+    started: primitives_1.unixSeconds.nullable(),
+    ended: primitives_1.unixSeconds.nullable(),
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.sales_destination',
+            id: 'taxdest_0193b8f2c1a87d3e9f4a',
+            livemode: false,
+            country: 'US',
+            state: 'TX',
+            customer_types: 'consumers',
+            started: 1767225600,
+            ended: null,
+            metadata: {},
+            created: 1793750400,
+        },
+    ],
+});
+/** Orbit's new sales destination (the owner's). */
+exports.createTaxSalesDestinationParams = zod_1.z
+    .object({
+    country: shared_1.complianceCountryParam,
+    state: shared_1.complianceStateParam.optional(),
+    customer_types: zod_1.z.enum(tax_1.TAX_CUSTOMER_TYPES).optional(),
+    started: shared_1.taxInstantParam.nullable().optional(),
+    ended: shared_1.taxInstantParam.nullable().optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+})
+    .strict();
+/** Orbit's update (the owner's): the place is fixed; `metadata` is a patch. */
+exports.updateTaxSalesDestinationParams = zod_1.z
+    .object({
+    customer_types: zod_1.z.enum(tax_1.TAX_CUSTOMER_TYPES).optional(),
+    started: shared_1.taxInstantParam.nullable().optional(),
+    ended: shared_1.taxInstantParam.nullable().optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+})
+    .strict();
+exports.listTaxSalesDestinationsQuery = (0, params_1.listQuery)({});
+exports.taxSalesDestinationRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listTaxSalesDestinations',
+        method: 'get',
+        path: '/v1/tax/sales_destinations',
+        tag: 'Tax compliance',
+        summary: 'List sales destinations',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listTaxSalesDestinationsQuery,
+        response: (0, envelopes_1.listOf)(exports.taxSalesDestinationSchema),
+        sdk: 'tax.compliance.listSalesDestinations',
+        expandable: 'tax.sales_destination',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxSalesDestination',
+        method: 'get',
+        path: '/v1/tax/sales_destinations/{id}',
+        tag: 'Tax compliance',
+        summary: 'Retrieve a sales destination',
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: 'The sales destination (`taxdest_…`).' },
+        query: params_1.expandOnlyQuery,
+        response: exports.taxSalesDestinationSchema,
+        sdk: 'tax.compliance.retrieveSalesDestination',
+        expandable: 'tax.sales_destination',
+    }),
+];