@peable.to/contracts 0.4.0 → 1.1.0
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/dist/cjs/common/address.js +81 -0
- package/dist/cjs/common/envelopes.js +101 -0
- package/dist/cjs/common/objects.js +85 -0
- package/dist/cjs/common/params.js +211 -0
- package/dist/cjs/common/primitives.js +39 -0
- package/dist/cjs/contributions.js +22 -0
- package/dist/cjs/index.js +40 -137
- package/dist/cjs/openapi/document.js +297 -0
- package/dist/cjs/openapi/index.js +7 -0
- package/dist/cjs/openapi/webhooks.js +17 -0
- package/dist/cjs/resources/billingEngine/billingPortal.js +237 -0
- package/dist/cjs/resources/billingEngine/creditNotes.js +189 -0
- package/dist/cjs/resources/billingEngine/customerBalanceTransactions.js +90 -0
- package/dist/cjs/resources/billingEngine/index.js +43 -0
- package/dist/cjs/resources/billingEngine/invoiceItems.js +155 -0
- package/dist/cjs/resources/billingEngine/invoices.js +509 -0
- package/dist/cjs/resources/billingEngine/params.js +43 -0
- package/dist/cjs/resources/billingEngine/public.js +326 -0
- package/dist/cjs/resources/billingEngine/subscriptions.js +476 -0
- package/dist/cjs/resources/catalog/billing.js +755 -0
- package/dist/cjs/resources/catalog/billingSettings.js +131 -0
- package/dist/cjs/resources/catalog/coupons.js +222 -0
- package/dist/cjs/resources/catalog/entitlements.js +257 -0
- package/dist/cjs/resources/catalog/index.js +58 -0
- package/dist/cjs/resources/catalog/meters.js +279 -0
- package/dist/cjs/resources/catalog/prices.js +423 -0
- package/dist/cjs/resources/catalog/products.js +228 -0
- package/dist/cjs/resources/catalog/promotionCodes.js +174 -0
- package/dist/cjs/resources/catalog/shared.js +75 -0
- package/dist/cjs/resources/catalog/testClocks.js +127 -0
- package/dist/cjs/resources/checkout/checkoutSessions.js +582 -0
- package/dist/cjs/resources/checkout/contributions.js +172 -0
- package/dist/cjs/resources/checkout/files.js +133 -0
- package/dist/cjs/resources/checkout/index.js +57 -0
- package/dist/cjs/resources/checkout/merchants.js +290 -0
- package/dist/cjs/resources/checkout/paymentLinks.js +330 -0
- package/dist/cjs/resources/checkout/paymentMethodConfigurations.js +262 -0
- package/dist/cjs/resources/checkout/shared.js +368 -0
- package/dist/cjs/resources/connect/account.js +332 -0
- package/dist/cjs/resources/connect/applicationFees.js +113 -0
- package/dist/cjs/resources/connect/balance.js +212 -0
- package/dist/cjs/resources/connect/connectedAccounts.js +260 -0
- package/dist/cjs/resources/connect/index.js +51 -0
- package/dist/cjs/resources/connect/onboarding.js +82 -0
- package/dist/cjs/resources/connect/payouts.js +196 -0
- package/dist/cjs/resources/connect/reporting.js +235 -0
- package/dist/cjs/resources/connect/requestLogs.js +110 -0
- package/dist/cjs/resources/connect/transfers.js +227 -0
- package/dist/cjs/resources/core/customers.js +194 -0
- package/dist/cjs/resources/core/index.js +23 -0
- package/dist/cjs/resources/core/paymentMethods.js +134 -0
- package/dist/cjs/resources/events/events.js +357 -0
- package/dist/cjs/resources/events/index.js +29 -0
- package/dist/cjs/resources/events/webhookDeliveries.js +93 -0
- package/dist/cjs/resources/events/webhookEndpoints.js +215 -0
- package/dist/cjs/resources/payments/charges.js +157 -0
- package/dist/cjs/resources/payments/disputes.js +204 -0
- package/dist/cjs/resources/payments/index.js +41 -0
- package/dist/cjs/resources/payments/paymentIntents.js +529 -0
- package/dist/cjs/resources/payments/refunds.js +245 -0
- package/dist/cjs/resources/payments/setupIntents.js +158 -0
- package/dist/cjs/resources/payments/social.js +182 -0
- package/dist/cjs/resources/payments/testHelpers.js +39 -0
- package/dist/cjs/resources/tax/assessments.js +217 -0
- package/dist/cjs/resources/tax/businessProfile.js +99 -0
- package/dist/cjs/resources/tax/calculations.js +176 -0
- package/dist/cjs/resources/tax/capabilities.js +42 -0
- package/dist/cjs/resources/tax/codes.js +37 -0
- package/dist/cjs/resources/tax/complianceActions.js +56 -0
- package/dist/cjs/resources/tax/deadlines.js +59 -0
- package/dist/cjs/resources/tax/documents.js +128 -0
- package/dist/cjs/resources/tax/index.js +80 -0
- package/dist/cjs/resources/tax/locationEvidence.js +131 -0
- package/dist/cjs/resources/tax/operatingLocations.js +98 -0
- package/dist/cjs/resources/tax/products.js +67 -0
- package/dist/cjs/resources/tax/registrationDeclarations.js +124 -0
- package/dist/cjs/resources/tax/registrations.js +82 -0
- package/dist/cjs/resources/tax/reports.js +92 -0
- package/dist/cjs/resources/tax/reviewItems.js +116 -0
- package/dist/cjs/resources/tax/ruleSet.js +68 -0
- package/dist/cjs/resources/tax/salesDestinations.js +94 -0
- package/dist/cjs/resources/tax/settings.js +104 -0
- package/dist/cjs/resources/tax/shared.js +62 -0
- package/dist/cjs/resources/tax/transactions.js +102 -0
- package/dist/cjs/route.js +22 -0
- package/dist/cjs/routes.js +31 -0
- package/dist/cjs/vocabulary/billingPortal.js +15 -0
- package/dist/cjs/vocabulary/catalog.js +110 -0
- package/dist/cjs/vocabulary/checkout.js +53 -0
- package/dist/cjs/vocabulary/connect.js +95 -0
- package/dist/cjs/vocabulary/dashboard.js +68 -0
- package/dist/cjs/vocabulary/errors.js +175 -0
- package/dist/cjs/vocabulary/events.js +176 -0
- package/dist/cjs/vocabulary/files.js +44 -0
- package/dist/cjs/vocabulary/identity.js +12 -0
- package/dist/cjs/vocabulary/index.js +39 -0
- package/dist/cjs/vocabulary/invoices.js +52 -0
- package/dist/cjs/vocabulary/lists.js +22 -0
- package/dist/cjs/vocabulary/merchants.js +23 -0
- package/dist/cjs/vocabulary/money.js +104 -0
- package/dist/cjs/vocabulary/paymentMethodConfigurations.js +36 -0
- package/dist/cjs/vocabulary/payments.js +195 -0
- package/dist/cjs/vocabulary/reporting.js +27 -0
- package/dist/cjs/vocabulary/subscriptions.js +60 -0
- package/dist/cjs/vocabulary/tax.js +237 -0
- package/dist/cjs/vocabulary/version.js +12 -0
- package/dist/esm/common/address.js +76 -0
- package/dist/esm/common/envelopes.js +95 -0
- package/dist/esm/common/objects.js +74 -0
- package/dist/esm/common/params.js +203 -0
- package/dist/esm/common/primitives.js +35 -0
- package/dist/esm/contributions.js +5 -0
- package/dist/esm/index.js +26 -134
- package/dist/esm/openapi/document.js +294 -0
- package/dist/esm/openapi/index.js +2 -0
- package/dist/esm/openapi/webhooks.js +14 -0
- package/dist/esm/resources/billingEngine/billingPortal.js +234 -0
- package/dist/esm/resources/billingEngine/creditNotes.js +186 -0
- package/dist/esm/resources/billingEngine/customerBalanceTransactions.js +87 -0
- package/dist/esm/resources/billingEngine/index.js +26 -0
- package/dist/esm/resources/billingEngine/invoiceItems.js +152 -0
- package/dist/esm/resources/billingEngine/invoices.js +506 -0
- package/dist/esm/resources/billingEngine/params.js +39 -0
- package/dist/esm/resources/billingEngine/public.js +323 -0
- package/dist/esm/resources/billingEngine/subscriptions.js +473 -0
- package/dist/esm/resources/catalog/billing.js +752 -0
- package/dist/esm/resources/catalog/billingSettings.js +128 -0
- package/dist/esm/resources/catalog/coupons.js +219 -0
- package/dist/esm/resources/catalog/entitlements.js +254 -0
- package/dist/esm/resources/catalog/index.js +38 -0
- package/dist/esm/resources/catalog/meters.js +276 -0
- package/dist/esm/resources/catalog/prices.js +419 -0
- package/dist/esm/resources/catalog/products.js +225 -0
- package/dist/esm/resources/catalog/promotionCodes.js +171 -0
- package/dist/esm/resources/catalog/shared.js +67 -0
- package/dist/esm/resources/catalog/testClocks.js +124 -0
- package/dist/esm/resources/checkout/checkoutSessions.js +579 -0
- package/dist/esm/resources/checkout/contributions.js +167 -0
- package/dist/esm/resources/checkout/files.js +130 -0
- package/dist/esm/resources/checkout/index.js +25 -0
- package/dist/esm/resources/checkout/merchants.js +287 -0
- package/dist/esm/resources/checkout/paymentLinks.js +327 -0
- package/dist/esm/resources/checkout/paymentMethodConfigurations.js +259 -0
- package/dist/esm/resources/checkout/shared.js +363 -0
- package/dist/esm/resources/connect/account.js +329 -0
- package/dist/esm/resources/connect/applicationFees.js +110 -0
- package/dist/esm/resources/connect/balance.js +209 -0
- package/dist/esm/resources/connect/connectedAccounts.js +257 -0
- package/dist/esm/resources/connect/index.js +34 -0
- package/dist/esm/resources/connect/onboarding.js +79 -0
- package/dist/esm/resources/connect/payouts.js +193 -0
- package/dist/esm/resources/connect/reporting.js +232 -0
- package/dist/esm/resources/connect/requestLogs.js +107 -0
- package/dist/esm/resources/connect/transfers.js +224 -0
- package/dist/esm/resources/core/customers.js +191 -0
- package/dist/esm/resources/core/index.js +6 -0
- package/dist/esm/resources/core/paymentMethods.js +131 -0
- package/dist/esm/resources/events/events.js +353 -0
- package/dist/esm/resources/events/index.js +12 -0
- package/dist/esm/resources/events/webhookDeliveries.js +90 -0
- package/dist/esm/resources/events/webhookEndpoints.js +212 -0
- package/dist/esm/resources/payments/charges.js +154 -0
- package/dist/esm/resources/payments/disputes.js +201 -0
- package/dist/esm/resources/payments/index.js +24 -0
- package/dist/esm/resources/payments/paymentIntents.js +526 -0
- package/dist/esm/resources/payments/refunds.js +242 -0
- package/dist/esm/resources/payments/setupIntents.js +155 -0
- package/dist/esm/resources/payments/social.js +179 -0
- package/dist/esm/resources/payments/testHelpers.js +36 -0
- package/dist/esm/resources/tax/assessments.js +214 -0
- package/dist/esm/resources/tax/businessProfile.js +96 -0
- package/dist/esm/resources/tax/calculations.js +173 -0
- package/dist/esm/resources/tax/capabilities.js +39 -0
- package/dist/esm/resources/tax/codes.js +34 -0
- package/dist/esm/resources/tax/complianceActions.js +53 -0
- package/dist/esm/resources/tax/deadlines.js +56 -0
- package/dist/esm/resources/tax/documents.js +125 -0
- package/dist/esm/resources/tax/index.js +63 -0
- package/dist/esm/resources/tax/locationEvidence.js +128 -0
- package/dist/esm/resources/tax/operatingLocations.js +95 -0
- package/dist/esm/resources/tax/products.js +64 -0
- package/dist/esm/resources/tax/registrationDeclarations.js +121 -0
- package/dist/esm/resources/tax/registrations.js +79 -0
- package/dist/esm/resources/tax/reports.js +89 -0
- package/dist/esm/resources/tax/reviewItems.js +113 -0
- package/dist/esm/resources/tax/ruleSet.js +65 -0
- package/dist/esm/resources/tax/salesDestinations.js +91 -0
- package/dist/esm/resources/tax/settings.js +101 -0
- package/dist/esm/resources/tax/shared.js +58 -0
- package/dist/esm/resources/tax/transactions.js +99 -0
- package/dist/esm/route.js +16 -0
- package/dist/esm/routes.js +27 -0
- package/dist/esm/vocabulary/billingPortal.js +12 -0
- package/dist/esm/vocabulary/catalog.js +106 -0
- package/dist/esm/vocabulary/checkout.js +50 -0
- package/dist/esm/vocabulary/connect.js +92 -0
- package/dist/esm/vocabulary/dashboard.js +64 -0
- package/dist/esm/vocabulary/errors.js +170 -0
- package/dist/esm/vocabulary/events.js +173 -0
- package/dist/esm/vocabulary/files.js +41 -0
- package/dist/esm/vocabulary/identity.js +9 -0
- package/dist/esm/vocabulary/index.js +23 -0
- package/dist/esm/vocabulary/invoices.js +49 -0
- package/dist/esm/vocabulary/lists.js +19 -0
- package/dist/esm/vocabulary/merchants.js +20 -0
- package/dist/esm/vocabulary/money.js +98 -0
- package/dist/esm/vocabulary/paymentMethodConfigurations.js +33 -0
- package/dist/esm/vocabulary/payments.js +192 -0
- package/dist/esm/vocabulary/reporting.js +24 -0
- package/dist/esm/vocabulary/subscriptions.js +57 -0
- package/dist/esm/vocabulary/tax.js +233 -0
- package/dist/esm/vocabulary/version.js +9 -0
- package/dist/types/common/address.d.ts +62 -0
- package/dist/types/common/envelopes.d.ts +88 -0
- package/dist/types/common/objects.d.ts +107 -0
- package/dist/types/common/params.d.ts +156 -0
- package/dist/types/common/primitives.d.ts +56 -0
- package/dist/types/contributions.d.ts +1 -0
- package/dist/types/index.d.ts +16 -171
- package/dist/types/openapi/document.d.ts +16 -0
- package/dist/types/openapi/index.d.ts +2 -0
- package/dist/types/openapi/webhooks.d.ts +15 -0
- package/dist/types/resources/billingEngine/billingPortal.d.ts +742 -0
- package/dist/types/resources/billingEngine/creditNotes.d.ts +655 -0
- package/dist/types/resources/billingEngine/customerBalanceTransactions.d.ts +282 -0
- package/dist/types/resources/billingEngine/index.d.ts +6071 -0
- package/dist/types/resources/billingEngine/invoiceItems.d.ts +502 -0
- package/dist/types/resources/billingEngine/invoices.d.ts +2547 -0
- package/dist/types/resources/billingEngine/params.d.ts +51 -0
- package/dist/types/resources/billingEngine/public.d.ts +1860 -0
- package/dist/types/resources/billingEngine/subscriptions.d.ts +1519 -0
- package/dist/types/resources/catalog/billing.d.ts +1723 -0
- package/dist/types/resources/catalog/billingSettings.d.ts +160 -0
- package/dist/types/resources/catalog/coupons.d.ts +403 -0
- package/dist/types/resources/catalog/entitlements.d.ts +422 -0
- package/dist/types/resources/catalog/index.d.ts +3155 -0
- package/dist/types/resources/catalog/meters.d.ts +474 -0
- package/dist/types/resources/catalog/prices.d.ts +1091 -0
- package/dist/types/resources/catalog/products.d.ts +430 -0
- package/dist/types/resources/catalog/promotionCodes.d.ts +369 -0
- package/dist/types/resources/catalog/shared.d.ts +34 -0
- package/dist/types/resources/catalog/testClocks.d.ts +220 -0
- package/dist/types/resources/checkout/checkoutSessions.d.ts +3207 -0
- package/dist/types/resources/checkout/contributions.d.ts +375 -0
- package/dist/types/resources/checkout/files.d.ts +280 -0
- package/dist/types/resources/checkout/index.d.ts +5678 -0
- package/dist/types/resources/checkout/merchants.d.ts +395 -0
- package/dist/types/resources/checkout/paymentLinks.d.ts +1728 -0
- package/dist/types/resources/checkout/paymentMethodConfigurations.d.ts +2104 -0
- package/dist/types/resources/checkout/shared.d.ts +419 -0
- package/dist/types/resources/connect/account.d.ts +483 -0
- package/dist/types/resources/connect/applicationFees.d.ts +198 -0
- package/dist/types/resources/connect/balance.d.ts +399 -0
- package/dist/types/resources/connect/connectedAccounts.d.ts +494 -0
- package/dist/types/resources/connect/index.d.ts +2094 -0
- package/dist/types/resources/connect/onboarding.d.ts +95 -0
- package/dist/types/resources/connect/payouts.d.ts +527 -0
- package/dist/types/resources/connect/reporting.d.ts +506 -0
- package/dist/types/resources/connect/requestLogs.d.ts +236 -0
- package/dist/types/resources/connect/transfers.d.ts +436 -0
- package/dist/types/resources/core/customers.d.ts +619 -0
- package/dist/types/resources/core/index.d.ts +679 -0
- package/dist/types/resources/core/paymentMethods.d.ts +336 -0
- package/dist/types/resources/events/events.d.ts +731 -0
- package/dist/types/resources/events/index.d.ts +1727 -0
- package/dist/types/resources/events/webhookDeliveries.d.ts +436 -0
- package/dist/types/resources/events/webhookEndpoints.d.ts +1502 -0
- package/dist/types/resources/payments/charges.d.ts +390 -0
- package/dist/types/resources/payments/disputes.d.ts +822 -0
- package/dist/types/resources/payments/index.d.ts +3517 -0
- package/dist/types/resources/payments/paymentIntents.d.ts +2080 -0
- package/dist/types/resources/payments/refunds.d.ts +684 -0
- package/dist/types/resources/payments/setupIntents.d.ts +391 -0
- package/dist/types/resources/payments/social.d.ts +266 -0
- package/dist/types/resources/payments/testHelpers.d.ts +178 -0
- package/dist/types/resources/tax/assessments.d.ts +787 -0
- package/dist/types/resources/tax/businessProfile.d.ts +134 -0
- package/dist/types/resources/tax/calculations.d.ts +261 -0
- package/dist/types/resources/tax/capabilities.d.ts +81 -0
- package/dist/types/resources/tax/codes.d.ts +29 -0
- package/dist/types/resources/tax/complianceActions.d.ts +97 -0
- package/dist/types/resources/tax/deadlines.d.ts +133 -0
- package/dist/types/resources/tax/documents.d.ts +257 -0
- package/dist/types/resources/tax/index.d.ts +1946 -0
- package/dist/types/resources/tax/locationEvidence.d.ts +246 -0
- package/dist/types/resources/tax/operatingLocations.d.ts +170 -0
- package/dist/types/resources/tax/products.d.ts +68 -0
- package/dist/types/resources/tax/registrationDeclarations.d.ts +270 -0
- package/dist/types/resources/tax/registrations.d.ts +103 -0
- package/dist/types/resources/tax/reports.d.ts +129 -0
- package/dist/types/resources/tax/reviewItems.d.ts +226 -0
- package/dist/types/resources/tax/ruleSet.d.ts +219 -0
- package/dist/types/resources/tax/salesDestinations.d.ts +158 -0
- package/dist/types/resources/tax/settings.d.ts +122 -0
- package/dist/types/resources/tax/shared.d.ts +43 -0
- package/dist/types/resources/tax/transactions.d.ts +404 -0
- package/dist/types/route.d.ts +86 -0
- package/dist/types/routes.d.ts +23 -0
- package/dist/types/vocabulary/billingPortal.d.ts +15 -0
- package/dist/types/vocabulary/catalog.d.ts +97 -0
- package/dist/types/vocabulary/checkout.d.ts +49 -0
- package/dist/types/vocabulary/connect.d.ts +62 -0
- package/dist/types/vocabulary/dashboard.d.ts +44 -0
- package/dist/types/vocabulary/errors.d.ts +146 -0
- package/dist/types/vocabulary/events.d.ts +171 -0
- package/dist/types/vocabulary/files.d.ts +30 -0
- package/dist/types/vocabulary/identity.d.ts +9 -0
- package/dist/types/vocabulary/index.d.ts +19 -0
- package/dist/types/vocabulary/invoices.d.ts +39 -0
- package/dist/types/vocabulary/lists.d.ts +9 -0
- package/dist/types/vocabulary/merchants.d.ts +9 -0
- package/dist/types/vocabulary/money.d.ts +59 -0
- package/dist/types/vocabulary/paymentMethodConfigurations.d.ts +22 -0
- package/dist/types/vocabulary/payments.d.ts +117 -0
- package/dist/types/vocabulary/reporting.d.ts +18 -0
- package/dist/types/vocabulary/subscriptions.d.ts +45 -0
- package/dist/types/vocabulary/tax.d.ts +163 -0
- package/dist/types/vocabulary/version.d.ts +10 -0
- package/package.json +51 -11
- package/dist/cjs/openapi.js +0 -165
- package/dist/esm/openapi.js +0 -161
- package/dist/types/openapi.d.ts +0 -148
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { type Expand } from '../../common/objects';
|
|
3
|
+
/**
|
|
4
|
+
* Peable Tax business compliance (ADR 0020): what a business tells Peable
|
|
5
|
+
* about itself, what Peable works out from it against a VERSIONED rule set
|
|
6
|
+
* (an assessment), and what needs a person's decision (the review queue).
|
|
7
|
+
* Nothing here registers, files or pays anything with a government, and
|
|
8
|
+
* nothing here turns tax collection on: that is still the owner's registration
|
|
9
|
+
* plus approval (ADR 0011). The merchant API reads it and may run an
|
|
10
|
+
* assessment; every onboarding fact and decision is the owner's, in Orbit.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* The business behind a merchant. Deliberately carries NO government
|
|
14
|
+
* identifier (company number, EIN): none is evidence of a tax obligation and
|
|
15
|
+
* none is needed by any rule in the supported set.
|
|
16
|
+
*/
|
|
17
|
+
export declare const taxBusinessProfileSchema: z.ZodObject<{
|
|
18
|
+
object: z.ZodLiteral<"tax.business_profile">;
|
|
19
|
+
livemode: z.ZodBoolean;
|
|
20
|
+
legal_name: z.ZodNullable<z.ZodString>;
|
|
21
|
+
entity_type: z.ZodEnum<{
|
|
22
|
+
unknown: "unknown";
|
|
23
|
+
corporation: "corporation";
|
|
24
|
+
limited_liability_company: "limited_liability_company";
|
|
25
|
+
partnership: "partnership";
|
|
26
|
+
sole_proprietorship: "sole_proprietorship";
|
|
27
|
+
nonprofit: "nonprofit";
|
|
28
|
+
public_body: "public_body";
|
|
29
|
+
other: "other";
|
|
30
|
+
}>;
|
|
31
|
+
incorporation_country: z.ZodNullable<z.ZodString>;
|
|
32
|
+
incorporation_state: z.ZodNullable<z.ZodString>;
|
|
33
|
+
fiscal_year_end_month: z.ZodNullable<z.ZodNumber>;
|
|
34
|
+
customer_types: z.ZodEnum<{
|
|
35
|
+
unknown: "unknown";
|
|
36
|
+
consumers: "consumers";
|
|
37
|
+
businesses: "businesses";
|
|
38
|
+
both: "both";
|
|
39
|
+
}>;
|
|
40
|
+
supply_types: z.ZodArray<z.ZodEnum<{
|
|
41
|
+
other: "other";
|
|
42
|
+
digital_services: "digital_services";
|
|
43
|
+
software_as_a_service: "software_as_a_service";
|
|
44
|
+
physical_goods: "physical_goods";
|
|
45
|
+
professional_services: "professional_services";
|
|
46
|
+
}>>;
|
|
47
|
+
missing: z.ZodArray<z.ZodString>;
|
|
48
|
+
metadata: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
49
|
+
updated_by: z.ZodNullable<z.ZodString>;
|
|
50
|
+
updated: z.ZodNullable<z.ZodNumber>;
|
|
51
|
+
}, z.core.$strict>;
|
|
52
|
+
export type TaxBusinessProfile = Expand<z.output<typeof taxBusinessProfileSchema>>;
|
|
53
|
+
declare module '../../common/objects' {
|
|
54
|
+
interface ObjectMap {
|
|
55
|
+
'tax.business_profile': TaxBusinessProfile;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
/** Orbit's profile update (the owner's); `metadata` is a patch. */
|
|
59
|
+
export declare const updateTaxBusinessProfileParams: z.ZodObject<{
|
|
60
|
+
entity_type: z.ZodOptional<z.ZodEnum<{
|
|
61
|
+
unknown: "unknown";
|
|
62
|
+
corporation: "corporation";
|
|
63
|
+
limited_liability_company: "limited_liability_company";
|
|
64
|
+
partnership: "partnership";
|
|
65
|
+
sole_proprietorship: "sole_proprietorship";
|
|
66
|
+
nonprofit: "nonprofit";
|
|
67
|
+
public_body: "public_body";
|
|
68
|
+
other: "other";
|
|
69
|
+
}>>;
|
|
70
|
+
incorporation_country: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
71
|
+
incorporation_state: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
72
|
+
fiscal_year_end_month: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
73
|
+
customer_types: z.ZodOptional<z.ZodEnum<{
|
|
74
|
+
unknown: "unknown";
|
|
75
|
+
consumers: "consumers";
|
|
76
|
+
businesses: "businesses";
|
|
77
|
+
both: "both";
|
|
78
|
+
}>>;
|
|
79
|
+
supply_types: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
80
|
+
other: "other";
|
|
81
|
+
digital_services: "digital_services";
|
|
82
|
+
software_as_a_service: "software_as_a_service";
|
|
83
|
+
physical_goods: "physical_goods";
|
|
84
|
+
professional_services: "professional_services";
|
|
85
|
+
}>>>;
|
|
86
|
+
metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
|
|
87
|
+
}, z.core.$strict>;
|
|
88
|
+
export type UpdateTaxBusinessProfileParams = z.input<typeof updateTaxBusinessProfileParams>;
|
|
89
|
+
export declare const taxBusinessProfileRoutes: readonly [{
|
|
90
|
+
readonly operationId: "retrieveTaxBusinessProfile";
|
|
91
|
+
readonly method: "get";
|
|
92
|
+
readonly path: "/v1/tax/business_profile";
|
|
93
|
+
readonly tag: "Tax compliance";
|
|
94
|
+
readonly summary: "Retrieve the business profile";
|
|
95
|
+
readonly description: "Changed by the owner in Orbit; a service credential records no onboarding fact.";
|
|
96
|
+
readonly auth: "service";
|
|
97
|
+
readonly scope: "payments:read";
|
|
98
|
+
readonly response: z.ZodObject<{
|
|
99
|
+
object: z.ZodLiteral<"tax.business_profile">;
|
|
100
|
+
livemode: z.ZodBoolean;
|
|
101
|
+
legal_name: z.ZodNullable<z.ZodString>;
|
|
102
|
+
entity_type: z.ZodEnum<{
|
|
103
|
+
unknown: "unknown";
|
|
104
|
+
corporation: "corporation";
|
|
105
|
+
limited_liability_company: "limited_liability_company";
|
|
106
|
+
partnership: "partnership";
|
|
107
|
+
sole_proprietorship: "sole_proprietorship";
|
|
108
|
+
nonprofit: "nonprofit";
|
|
109
|
+
public_body: "public_body";
|
|
110
|
+
other: "other";
|
|
111
|
+
}>;
|
|
112
|
+
incorporation_country: z.ZodNullable<z.ZodString>;
|
|
113
|
+
incorporation_state: z.ZodNullable<z.ZodString>;
|
|
114
|
+
fiscal_year_end_month: z.ZodNullable<z.ZodNumber>;
|
|
115
|
+
customer_types: z.ZodEnum<{
|
|
116
|
+
unknown: "unknown";
|
|
117
|
+
consumers: "consumers";
|
|
118
|
+
businesses: "businesses";
|
|
119
|
+
both: "both";
|
|
120
|
+
}>;
|
|
121
|
+
supply_types: z.ZodArray<z.ZodEnum<{
|
|
122
|
+
other: "other";
|
|
123
|
+
digital_services: "digital_services";
|
|
124
|
+
software_as_a_service: "software_as_a_service";
|
|
125
|
+
physical_goods: "physical_goods";
|
|
126
|
+
professional_services: "professional_services";
|
|
127
|
+
}>>;
|
|
128
|
+
missing: z.ZodArray<z.ZodString>;
|
|
129
|
+
metadata: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
130
|
+
updated_by: z.ZodNullable<z.ZodString>;
|
|
131
|
+
updated: z.ZodNullable<z.ZodNumber>;
|
|
132
|
+
}, z.core.$strict>;
|
|
133
|
+
readonly sdk: "tax.compliance.retrieveBusinessProfile";
|
|
134
|
+
}];
|
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { type Expand } from '../../common/objects';
|
|
3
|
+
/**
|
|
4
|
+
* A tax calculation (`taxcalc_…`, ADR 0011): a frozen answer. Peable decides
|
|
5
|
+
* whether a registration covers the customer's evidenced location and asks
|
|
6
|
+
* the provider for the amount only when one does; the answer is stored exactly
|
|
7
|
+
* as given and never recomputed.
|
|
8
|
+
*/
|
|
9
|
+
export declare const taxBreakdownEntrySchema: z.ZodObject<{
|
|
10
|
+
country: z.ZodString;
|
|
11
|
+
state: z.ZodNullable<z.ZodString>;
|
|
12
|
+
level: z.ZodNullable<z.ZodString>;
|
|
13
|
+
display_name: z.ZodNullable<z.ZodString>;
|
|
14
|
+
tax_type: z.ZodNullable<z.ZodString>;
|
|
15
|
+
rate_percentage: z.ZodNullable<z.ZodString>;
|
|
16
|
+
taxable_amount: z.ZodNumber;
|
|
17
|
+
amount: z.ZodNumber;
|
|
18
|
+
inclusive: z.ZodBoolean;
|
|
19
|
+
taxability_reason: z.ZodString;
|
|
20
|
+
}, z.core.$strict>;
|
|
21
|
+
export type TaxBreakdownEntry = z.output<typeof taxBreakdownEntrySchema>;
|
|
22
|
+
export declare const taxCalculationLineItemSchema: z.ZodObject<{
|
|
23
|
+
reference: z.ZodString;
|
|
24
|
+
quantity: z.ZodNumber;
|
|
25
|
+
tax_code: z.ZodString;
|
|
26
|
+
tax_behavior: z.ZodEnum<{
|
|
27
|
+
inclusive: "inclusive";
|
|
28
|
+
exclusive: "exclusive";
|
|
29
|
+
}>;
|
|
30
|
+
amount: z.ZodNumber;
|
|
31
|
+
amount_tax: z.ZodNumber;
|
|
32
|
+
amount_net: z.ZodNumber;
|
|
33
|
+
breakdown: z.ZodArray<z.ZodObject<{
|
|
34
|
+
country: z.ZodString;
|
|
35
|
+
state: z.ZodNullable<z.ZodString>;
|
|
36
|
+
level: z.ZodNullable<z.ZodString>;
|
|
37
|
+
display_name: z.ZodNullable<z.ZodString>;
|
|
38
|
+
tax_type: z.ZodNullable<z.ZodString>;
|
|
39
|
+
rate_percentage: z.ZodNullable<z.ZodString>;
|
|
40
|
+
taxable_amount: z.ZodNumber;
|
|
41
|
+
amount: z.ZodNumber;
|
|
42
|
+
inclusive: z.ZodBoolean;
|
|
43
|
+
taxability_reason: z.ZodString;
|
|
44
|
+
}, z.core.$strict>>;
|
|
45
|
+
}, z.core.$strict>;
|
|
46
|
+
export type TaxCalculationLineItem = z.output<typeof taxCalculationLineItemSchema>;
|
|
47
|
+
export declare const taxCalculationSchema: z.ZodObject<{
|
|
48
|
+
object: z.ZodLiteral<"tax.calculation">;
|
|
49
|
+
id: z.ZodString;
|
|
50
|
+
currency: z.ZodString;
|
|
51
|
+
collection: z.ZodEnum<{
|
|
52
|
+
collect: "collect";
|
|
53
|
+
not_registered: "not_registered";
|
|
54
|
+
nontaxable: "nontaxable";
|
|
55
|
+
}>;
|
|
56
|
+
registration_id: z.ZodNullable<z.ZodString>;
|
|
57
|
+
provider: z.ZodNullable<z.ZodString>;
|
|
58
|
+
provider_calculation_ref: z.ZodNullable<z.ZodString>;
|
|
59
|
+
customer_location_evidence_id: z.ZodString;
|
|
60
|
+
country: z.ZodString;
|
|
61
|
+
state: z.ZodNullable<z.ZodString>;
|
|
62
|
+
amount_total: z.ZodNumber;
|
|
63
|
+
amount_net: z.ZodNumber;
|
|
64
|
+
tax_amount_exclusive: z.ZodNumber;
|
|
65
|
+
tax_amount_inclusive: z.ZodNumber;
|
|
66
|
+
line_items: z.ZodArray<z.ZodObject<{
|
|
67
|
+
reference: z.ZodString;
|
|
68
|
+
quantity: z.ZodNumber;
|
|
69
|
+
tax_code: z.ZodString;
|
|
70
|
+
tax_behavior: z.ZodEnum<{
|
|
71
|
+
inclusive: "inclusive";
|
|
72
|
+
exclusive: "exclusive";
|
|
73
|
+
}>;
|
|
74
|
+
amount: z.ZodNumber;
|
|
75
|
+
amount_tax: z.ZodNumber;
|
|
76
|
+
amount_net: z.ZodNumber;
|
|
77
|
+
breakdown: z.ZodArray<z.ZodObject<{
|
|
78
|
+
country: z.ZodString;
|
|
79
|
+
state: z.ZodNullable<z.ZodString>;
|
|
80
|
+
level: z.ZodNullable<z.ZodString>;
|
|
81
|
+
display_name: z.ZodNullable<z.ZodString>;
|
|
82
|
+
tax_type: z.ZodNullable<z.ZodString>;
|
|
83
|
+
rate_percentage: z.ZodNullable<z.ZodString>;
|
|
84
|
+
taxable_amount: z.ZodNumber;
|
|
85
|
+
amount: z.ZodNumber;
|
|
86
|
+
inclusive: z.ZodBoolean;
|
|
87
|
+
taxability_reason: z.ZodString;
|
|
88
|
+
}, z.core.$strict>>;
|
|
89
|
+
}, z.core.$strict>>;
|
|
90
|
+
tax_date: z.ZodNumber;
|
|
91
|
+
created: z.ZodNumber;
|
|
92
|
+
expires_at: z.ZodNumber;
|
|
93
|
+
livemode: z.ZodBoolean;
|
|
94
|
+
}, z.core.$strict>;
|
|
95
|
+
export type TaxCalculation = Expand<z.output<typeof taxCalculationSchema>>;
|
|
96
|
+
declare module '../../common/objects' {
|
|
97
|
+
interface ObjectMap {
|
|
98
|
+
'tax.calculation': TaxCalculation;
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
export declare const taxLineItemParams: z.ZodObject<{
|
|
102
|
+
reference: z.ZodString;
|
|
103
|
+
amount: z.ZodNumber;
|
|
104
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
105
|
+
tax_code: z.ZodOptional<z.ZodString>;
|
|
106
|
+
tax_behavior: z.ZodOptional<z.ZodEnum<{
|
|
107
|
+
inclusive: "inclusive";
|
|
108
|
+
exclusive: "exclusive";
|
|
109
|
+
}>>;
|
|
110
|
+
}, z.core.$strict>;
|
|
111
|
+
export type TaxLineItemParams = z.input<typeof taxLineItemParams>;
|
|
112
|
+
export declare const createTaxCalculationParams: z.ZodObject<{
|
|
113
|
+
currency: z.ZodString;
|
|
114
|
+
customer_location_evidence_id: z.ZodString;
|
|
115
|
+
line_items: z.ZodArray<z.ZodObject<{
|
|
116
|
+
reference: z.ZodString;
|
|
117
|
+
amount: z.ZodNumber;
|
|
118
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
119
|
+
tax_code: z.ZodOptional<z.ZodString>;
|
|
120
|
+
tax_behavior: z.ZodOptional<z.ZodEnum<{
|
|
121
|
+
inclusive: "inclusive";
|
|
122
|
+
exclusive: "exclusive";
|
|
123
|
+
}>>;
|
|
124
|
+
}, z.core.$strict>>;
|
|
125
|
+
}, z.core.$strict>;
|
|
126
|
+
export type CreateTaxCalculationParams = z.input<typeof createTaxCalculationParams>;
|
|
127
|
+
export declare const taxCalculationRoutes: readonly [{
|
|
128
|
+
readonly operationId: "createTaxCalculation";
|
|
129
|
+
readonly method: "post";
|
|
130
|
+
readonly path: "/v1/tax/calculations";
|
|
131
|
+
readonly tag: "Tax";
|
|
132
|
+
readonly summary: "Calculate tax";
|
|
133
|
+
readonly description: "Calculate and freeze. Refused with `tax_settings_not_active` until the owner approves; a covered sale the provider cannot price fails closed (`tax_calculation_unavailable`), never zero.";
|
|
134
|
+
readonly auth: "service";
|
|
135
|
+
readonly scope: "payments:write";
|
|
136
|
+
readonly idempotent: true;
|
|
137
|
+
readonly body: z.ZodObject<{
|
|
138
|
+
currency: z.ZodString;
|
|
139
|
+
customer_location_evidence_id: z.ZodString;
|
|
140
|
+
line_items: z.ZodArray<z.ZodObject<{
|
|
141
|
+
reference: z.ZodString;
|
|
142
|
+
amount: z.ZodNumber;
|
|
143
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
144
|
+
tax_code: z.ZodOptional<z.ZodString>;
|
|
145
|
+
tax_behavior: z.ZodOptional<z.ZodEnum<{
|
|
146
|
+
inclusive: "inclusive";
|
|
147
|
+
exclusive: "exclusive";
|
|
148
|
+
}>>;
|
|
149
|
+
}, z.core.$strict>>;
|
|
150
|
+
}, z.core.$strict>;
|
|
151
|
+
readonly response: z.ZodObject<{
|
|
152
|
+
object: z.ZodLiteral<"tax.calculation">;
|
|
153
|
+
id: z.ZodString;
|
|
154
|
+
currency: z.ZodString;
|
|
155
|
+
collection: z.ZodEnum<{
|
|
156
|
+
collect: "collect";
|
|
157
|
+
not_registered: "not_registered";
|
|
158
|
+
nontaxable: "nontaxable";
|
|
159
|
+
}>;
|
|
160
|
+
registration_id: z.ZodNullable<z.ZodString>;
|
|
161
|
+
provider: z.ZodNullable<z.ZodString>;
|
|
162
|
+
provider_calculation_ref: z.ZodNullable<z.ZodString>;
|
|
163
|
+
customer_location_evidence_id: z.ZodString;
|
|
164
|
+
country: z.ZodString;
|
|
165
|
+
state: z.ZodNullable<z.ZodString>;
|
|
166
|
+
amount_total: z.ZodNumber;
|
|
167
|
+
amount_net: z.ZodNumber;
|
|
168
|
+
tax_amount_exclusive: z.ZodNumber;
|
|
169
|
+
tax_amount_inclusive: z.ZodNumber;
|
|
170
|
+
line_items: z.ZodArray<z.ZodObject<{
|
|
171
|
+
reference: z.ZodString;
|
|
172
|
+
quantity: z.ZodNumber;
|
|
173
|
+
tax_code: z.ZodString;
|
|
174
|
+
tax_behavior: z.ZodEnum<{
|
|
175
|
+
inclusive: "inclusive";
|
|
176
|
+
exclusive: "exclusive";
|
|
177
|
+
}>;
|
|
178
|
+
amount: z.ZodNumber;
|
|
179
|
+
amount_tax: z.ZodNumber;
|
|
180
|
+
amount_net: z.ZodNumber;
|
|
181
|
+
breakdown: z.ZodArray<z.ZodObject<{
|
|
182
|
+
country: z.ZodString;
|
|
183
|
+
state: z.ZodNullable<z.ZodString>;
|
|
184
|
+
level: z.ZodNullable<z.ZodString>;
|
|
185
|
+
display_name: z.ZodNullable<z.ZodString>;
|
|
186
|
+
tax_type: z.ZodNullable<z.ZodString>;
|
|
187
|
+
rate_percentage: z.ZodNullable<z.ZodString>;
|
|
188
|
+
taxable_amount: z.ZodNumber;
|
|
189
|
+
amount: z.ZodNumber;
|
|
190
|
+
inclusive: z.ZodBoolean;
|
|
191
|
+
taxability_reason: z.ZodString;
|
|
192
|
+
}, z.core.$strict>>;
|
|
193
|
+
}, z.core.$strict>>;
|
|
194
|
+
tax_date: z.ZodNumber;
|
|
195
|
+
created: z.ZodNumber;
|
|
196
|
+
expires_at: z.ZodNumber;
|
|
197
|
+
livemode: z.ZodBoolean;
|
|
198
|
+
}, z.core.$strict>;
|
|
199
|
+
readonly status: 201;
|
|
200
|
+
readonly sdk: "tax.calculations.create";
|
|
201
|
+
}, {
|
|
202
|
+
readonly operationId: "retrieveTaxCalculation";
|
|
203
|
+
readonly method: "get";
|
|
204
|
+
readonly path: "/v1/tax/calculations/{id}";
|
|
205
|
+
readonly tag: "Tax";
|
|
206
|
+
readonly summary: "Retrieve a tax calculation";
|
|
207
|
+
readonly auth: "service";
|
|
208
|
+
readonly scope: "payments:read";
|
|
209
|
+
readonly params: {
|
|
210
|
+
readonly id: "The calculation (`taxcalc_…`).";
|
|
211
|
+
};
|
|
212
|
+
readonly response: z.ZodObject<{
|
|
213
|
+
object: z.ZodLiteral<"tax.calculation">;
|
|
214
|
+
id: z.ZodString;
|
|
215
|
+
currency: z.ZodString;
|
|
216
|
+
collection: z.ZodEnum<{
|
|
217
|
+
collect: "collect";
|
|
218
|
+
not_registered: "not_registered";
|
|
219
|
+
nontaxable: "nontaxable";
|
|
220
|
+
}>;
|
|
221
|
+
registration_id: z.ZodNullable<z.ZodString>;
|
|
222
|
+
provider: z.ZodNullable<z.ZodString>;
|
|
223
|
+
provider_calculation_ref: z.ZodNullable<z.ZodString>;
|
|
224
|
+
customer_location_evidence_id: z.ZodString;
|
|
225
|
+
country: z.ZodString;
|
|
226
|
+
state: z.ZodNullable<z.ZodString>;
|
|
227
|
+
amount_total: z.ZodNumber;
|
|
228
|
+
amount_net: z.ZodNumber;
|
|
229
|
+
tax_amount_exclusive: z.ZodNumber;
|
|
230
|
+
tax_amount_inclusive: z.ZodNumber;
|
|
231
|
+
line_items: z.ZodArray<z.ZodObject<{
|
|
232
|
+
reference: z.ZodString;
|
|
233
|
+
quantity: z.ZodNumber;
|
|
234
|
+
tax_code: z.ZodString;
|
|
235
|
+
tax_behavior: z.ZodEnum<{
|
|
236
|
+
inclusive: "inclusive";
|
|
237
|
+
exclusive: "exclusive";
|
|
238
|
+
}>;
|
|
239
|
+
amount: z.ZodNumber;
|
|
240
|
+
amount_tax: z.ZodNumber;
|
|
241
|
+
amount_net: z.ZodNumber;
|
|
242
|
+
breakdown: z.ZodArray<z.ZodObject<{
|
|
243
|
+
country: z.ZodString;
|
|
244
|
+
state: z.ZodNullable<z.ZodString>;
|
|
245
|
+
level: z.ZodNullable<z.ZodString>;
|
|
246
|
+
display_name: z.ZodNullable<z.ZodString>;
|
|
247
|
+
tax_type: z.ZodNullable<z.ZodString>;
|
|
248
|
+
rate_percentage: z.ZodNullable<z.ZodString>;
|
|
249
|
+
taxable_amount: z.ZodNumber;
|
|
250
|
+
amount: z.ZodNumber;
|
|
251
|
+
inclusive: z.ZodBoolean;
|
|
252
|
+
taxability_reason: z.ZodString;
|
|
253
|
+
}, z.core.$strict>>;
|
|
254
|
+
}, z.core.$strict>>;
|
|
255
|
+
tax_date: z.ZodNumber;
|
|
256
|
+
created: z.ZodNumber;
|
|
257
|
+
expires_at: z.ZodNumber;
|
|
258
|
+
livemode: z.ZodBoolean;
|
|
259
|
+
}, z.core.$strict>;
|
|
260
|
+
readonly sdk: "tax.calculations.retrieve";
|
|
261
|
+
}];
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { type Expand } from '../../common/objects';
|
|
3
|
+
/** What Peable Tax compliance can and cannot do, each stated rather than simulated. */
|
|
4
|
+
export declare const taxComplianceCapabilitySchema: z.ZodObject<{
|
|
5
|
+
id: z.ZodString;
|
|
6
|
+
category: z.ZodEnum<{
|
|
7
|
+
vat_sales_tax: "vat_sales_tax";
|
|
8
|
+
corporate_income_tax: "corporate_income_tax";
|
|
9
|
+
annual_company_filings: "annual_company_filings";
|
|
10
|
+
workflow: "workflow";
|
|
11
|
+
}>;
|
|
12
|
+
status: z.ZodEnum<{
|
|
13
|
+
available: "available";
|
|
14
|
+
limited: "limited";
|
|
15
|
+
not_available: "not_available";
|
|
16
|
+
out_of_scope: "out_of_scope";
|
|
17
|
+
}>;
|
|
18
|
+
reason: z.ZodString;
|
|
19
|
+
}, z.core.$strict>;
|
|
20
|
+
export type TaxComplianceCapability = z.output<typeof taxComplianceCapabilitySchema>;
|
|
21
|
+
export declare const taxComplianceCapabilitiesSchema: z.ZodObject<{
|
|
22
|
+
object: z.ZodLiteral<"tax.compliance_capabilities">;
|
|
23
|
+
livemode: z.ZodBoolean;
|
|
24
|
+
rule_set_version: z.ZodString;
|
|
25
|
+
supported_rules: z.ZodArray<z.ZodString>;
|
|
26
|
+
capabilities: z.ZodArray<z.ZodObject<{
|
|
27
|
+
id: z.ZodString;
|
|
28
|
+
category: z.ZodEnum<{
|
|
29
|
+
vat_sales_tax: "vat_sales_tax";
|
|
30
|
+
corporate_income_tax: "corporate_income_tax";
|
|
31
|
+
annual_company_filings: "annual_company_filings";
|
|
32
|
+
workflow: "workflow";
|
|
33
|
+
}>;
|
|
34
|
+
status: z.ZodEnum<{
|
|
35
|
+
available: "available";
|
|
36
|
+
limited: "limited";
|
|
37
|
+
not_available: "not_available";
|
|
38
|
+
out_of_scope: "out_of_scope";
|
|
39
|
+
}>;
|
|
40
|
+
reason: z.ZodString;
|
|
41
|
+
}, z.core.$strict>>;
|
|
42
|
+
}, z.core.$strict>;
|
|
43
|
+
export type TaxComplianceCapabilities = Expand<z.output<typeof taxComplianceCapabilitiesSchema>>;
|
|
44
|
+
declare module '../../common/objects' {
|
|
45
|
+
interface ObjectMap {
|
|
46
|
+
'tax.compliance_capabilities': TaxComplianceCapabilities;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
export declare const taxCapabilityRoutes: readonly [{
|
|
50
|
+
readonly operationId: "retrieveTaxComplianceCapabilities";
|
|
51
|
+
readonly method: "get";
|
|
52
|
+
readonly path: "/v1/tax/capabilities";
|
|
53
|
+
readonly tag: "Tax compliance";
|
|
54
|
+
readonly summary: "Retrieve compliance capabilities";
|
|
55
|
+
readonly description: "What is available, limited, not available or out of scope — Peable submits, files and pays nothing with any authority.";
|
|
56
|
+
readonly auth: "service";
|
|
57
|
+
readonly scope: "payments:read";
|
|
58
|
+
readonly response: z.ZodObject<{
|
|
59
|
+
object: z.ZodLiteral<"tax.compliance_capabilities">;
|
|
60
|
+
livemode: z.ZodBoolean;
|
|
61
|
+
rule_set_version: z.ZodString;
|
|
62
|
+
supported_rules: z.ZodArray<z.ZodString>;
|
|
63
|
+
capabilities: z.ZodArray<z.ZodObject<{
|
|
64
|
+
id: z.ZodString;
|
|
65
|
+
category: z.ZodEnum<{
|
|
66
|
+
vat_sales_tax: "vat_sales_tax";
|
|
67
|
+
corporate_income_tax: "corporate_income_tax";
|
|
68
|
+
annual_company_filings: "annual_company_filings";
|
|
69
|
+
workflow: "workflow";
|
|
70
|
+
}>;
|
|
71
|
+
status: z.ZodEnum<{
|
|
72
|
+
available: "available";
|
|
73
|
+
limited: "limited";
|
|
74
|
+
not_available: "not_available";
|
|
75
|
+
out_of_scope: "out_of_scope";
|
|
76
|
+
}>;
|
|
77
|
+
reason: z.ZodString;
|
|
78
|
+
}, z.core.$strict>>;
|
|
79
|
+
}, z.core.$strict>;
|
|
80
|
+
readonly sdk: "tax.compliance.retrieveCapabilities";
|
|
81
|
+
}];
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/** A product tax code Peable accepts (`txcd_…`, Stripe Tax's ids). */
|
|
3
|
+
export declare const taxCodeSchema: z.ZodObject<{
|
|
4
|
+
id: z.ZodString;
|
|
5
|
+
name: z.ZodString;
|
|
6
|
+
description: z.ZodString;
|
|
7
|
+
}, z.core.$strict>;
|
|
8
|
+
export type TaxCode = z.output<typeof taxCodeSchema>;
|
|
9
|
+
export declare const taxCodeRoutes: readonly [{
|
|
10
|
+
readonly operationId: "listTaxCodes";
|
|
11
|
+
readonly method: "get";
|
|
12
|
+
readonly path: "/v1/tax/codes";
|
|
13
|
+
readonly tag: "Tax";
|
|
14
|
+
readonly summary: "List tax codes";
|
|
15
|
+
readonly description: "Every product tax code Peable accepts: a complete list, `has_more` is `false`.";
|
|
16
|
+
readonly auth: "service";
|
|
17
|
+
readonly scope: "payments:read";
|
|
18
|
+
readonly response: z.ZodObject<{
|
|
19
|
+
object: z.ZodLiteral<"list">;
|
|
20
|
+
data: z.ZodArray<z.ZodObject<{
|
|
21
|
+
id: z.ZodString;
|
|
22
|
+
name: z.ZodString;
|
|
23
|
+
description: z.ZodString;
|
|
24
|
+
}, z.core.$strict>>;
|
|
25
|
+
has_more: z.ZodBoolean;
|
|
26
|
+
url: z.ZodString;
|
|
27
|
+
}, z.core.$strict>;
|
|
28
|
+
readonly sdk: "tax.listCodes";
|
|
29
|
+
}];
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { type Expand } from '../../common/objects';
|
|
3
|
+
/** One recorded compliance change (`taxact_…`), written in the transaction of the change itself. */
|
|
4
|
+
export declare const taxComplianceActionSchema: z.ZodObject<{
|
|
5
|
+
object: z.ZodLiteral<"tax.compliance_action">;
|
|
6
|
+
id: z.ZodString;
|
|
7
|
+
livemode: z.ZodBoolean;
|
|
8
|
+
action: z.ZodString;
|
|
9
|
+
actor: z.ZodObject<{
|
|
10
|
+
type: z.ZodEnum<{
|
|
11
|
+
service: "service";
|
|
12
|
+
user: "user";
|
|
13
|
+
system: "system";
|
|
14
|
+
}>;
|
|
15
|
+
id: z.ZodNullable<z.ZodString>;
|
|
16
|
+
}, z.core.$strict>;
|
|
17
|
+
object_type: z.ZodString;
|
|
18
|
+
object_id: z.ZodNullable<z.ZodString>;
|
|
19
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
|
|
20
|
+
created: z.ZodNumber;
|
|
21
|
+
}, z.core.$strict>;
|
|
22
|
+
export type TaxComplianceAction = Expand<z.output<typeof taxComplianceActionSchema>>;
|
|
23
|
+
declare module '../../common/objects' {
|
|
24
|
+
interface ObjectMap {
|
|
25
|
+
'tax.compliance_action': TaxComplianceAction;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
export declare const listTaxComplianceActionsQuery: z.ZodObject<{
|
|
29
|
+
limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
|
|
30
|
+
starting_after: z.ZodOptional<z.ZodString>;
|
|
31
|
+
ending_before: z.ZodOptional<z.ZodString>;
|
|
32
|
+
created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
|
|
33
|
+
gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
34
|
+
gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
35
|
+
lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
36
|
+
lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
37
|
+
}, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
|
|
38
|
+
gt?: number | undefined;
|
|
39
|
+
gte?: number | undefined;
|
|
40
|
+
lt?: number | undefined;
|
|
41
|
+
lte?: number | undefined;
|
|
42
|
+
}>>]>>;
|
|
43
|
+
expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
|
|
44
|
+
}, z.core.$strict>;
|
|
45
|
+
export type ListTaxComplianceActionsParams = z.input<typeof listTaxComplianceActionsQuery>;
|
|
46
|
+
export declare const taxComplianceActionRoutes: readonly [{
|
|
47
|
+
readonly operationId: "listTaxComplianceActions";
|
|
48
|
+
readonly method: "get";
|
|
49
|
+
readonly path: "/v1/tax/compliance_actions";
|
|
50
|
+
readonly tag: "Tax compliance";
|
|
51
|
+
readonly summary: "List compliance actions";
|
|
52
|
+
readonly description: "The history of every compliance change, newest first.";
|
|
53
|
+
readonly auth: "service";
|
|
54
|
+
readonly scope: "payments:read";
|
|
55
|
+
readonly query: z.ZodObject<{
|
|
56
|
+
limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
|
|
57
|
+
starting_after: z.ZodOptional<z.ZodString>;
|
|
58
|
+
ending_before: z.ZodOptional<z.ZodString>;
|
|
59
|
+
created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
|
|
60
|
+
gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
61
|
+
gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
62
|
+
lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
63
|
+
lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
|
|
64
|
+
}, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
|
|
65
|
+
gt?: number | undefined;
|
|
66
|
+
gte?: number | undefined;
|
|
67
|
+
lt?: number | undefined;
|
|
68
|
+
lte?: number | undefined;
|
|
69
|
+
}>>]>>;
|
|
70
|
+
expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
|
|
71
|
+
}, z.core.$strict>;
|
|
72
|
+
readonly response: z.ZodObject<{
|
|
73
|
+
object: z.ZodLiteral<"list">;
|
|
74
|
+
data: z.ZodArray<z.ZodObject<{
|
|
75
|
+
object: z.ZodLiteral<"tax.compliance_action">;
|
|
76
|
+
id: z.ZodString;
|
|
77
|
+
livemode: z.ZodBoolean;
|
|
78
|
+
action: z.ZodString;
|
|
79
|
+
actor: z.ZodObject<{
|
|
80
|
+
type: z.ZodEnum<{
|
|
81
|
+
service: "service";
|
|
82
|
+
user: "user";
|
|
83
|
+
system: "system";
|
|
84
|
+
}>;
|
|
85
|
+
id: z.ZodNullable<z.ZodString>;
|
|
86
|
+
}, z.core.$strict>;
|
|
87
|
+
object_type: z.ZodString;
|
|
88
|
+
object_id: z.ZodNullable<z.ZodString>;
|
|
89
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
|
|
90
|
+
created: z.ZodNumber;
|
|
91
|
+
}, z.core.$strict>>;
|
|
92
|
+
has_more: z.ZodBoolean;
|
|
93
|
+
url: z.ZodString;
|
|
94
|
+
}, z.core.$strict>;
|
|
95
|
+
readonly sdk: "tax.compliance.listActions";
|
|
96
|
+
readonly expandable: "tax.compliance_action";
|
|
97
|
+
}];
|