@wix/auto_sdk_get-paid_receipts 1.0.217 → 1.0.219

package/build/internal/cjs/index.typings.d.ts

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /**
  * A receipt is a document that confirms a Wix user has received money or property as payment following a sale, transfer of goods, or provision of a service.
@@ -86,6 +86,8 @@ interface Receipt {
      * @maxSize 100
      */
     taxBreakdown?: Tax[];
+    /** Indicates if there were exempt from tax. */
+    taxExempt?: boolean | null;
     /**
      * Receipt preset ID.
      * Defaults to the default receipt preset ID, available with Get Default Receipt Preset ID.
@@ -471,6 +473,12 @@ interface LineItemTax {
      * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
      */
     taxAmount?: string;
+    /**
+     * Exempt amount from tax calculated for this line item.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    exemptAmount?: string | null;
 }
 interface LineItemTotals {
     /**
@@ -497,6 +505,12 @@ interface LineItemTotals {
      * @decimalValue options { gte:-1000000000000000, lte:1000000000000000, maxScale:4 }
      */
     totalPriceAfterTax?: string | null;
+    /**
+     * Line item total price that was exempt from tax.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    totalExemptAmount?: string | null;
 }
 interface ShippingInfo {
     /**
@@ -521,6 +535,12 @@ interface ShippingInfo {
      * @maxSize 10
      */
     taxBreakdown?: ShippingTax[];
+    /**
+     * Shipping price that was exempt from tax.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    exemptAmount?: string | null;
 }
 interface ShippingTax {
     /**
@@ -541,6 +561,12 @@ interface ShippingTax {
      * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
      */
     amount?: string;
+    /**
+     * Exempt amount from tax.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    exemptAmount?: string | null;
 }
 interface AdditionalFee {
     /**
@@ -567,6 +593,12 @@ interface AdditionalFee {
      * @maxSize 10
      */
     taxBreakdown?: AdditionalFeeTax[];
+    /**
+     * Additional fee price that was exempt from tax.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    exemptAmount?: string | null;
 }
 interface AdditionalFeeTax {
     /**
@@ -587,6 +619,12 @@ interface AdditionalFeeTax {
      * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
      */
     amount?: string;
+    /**
+     * Exempt amount from tax.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    exemptAmount?: string | null;
 }
 interface Discount {
     /**
@@ -667,6 +705,12 @@ interface Totals {
      * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
      */
     total?: string | null;
+    /**
+     * Total amount that was exempt from tax.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    exempt?: string | null;
 }
 interface Tax {
     /**
@@ -692,6 +736,12 @@ interface Tax {
      * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
      */
     taxableAmount?: string;
+    /**
+     * Exempt amount from tax.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    exemptAmount?: string | null;
 }
 interface CustomFields {
     /**
@@ -1250,8 +1300,6 @@ interface ReceiptCreatedEnvelope {
  * Triggered when a receipt is created.
  * @permissionScope Manage Receipts
  * @permissionScopeId SCOPE.RECEIPTS.MANAGE
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionId RECEIPTS.RECEIPT_READ
  * @webhook
  * @eventType wix.receipts.v1.receipt_created
@@ -1266,8 +1314,6 @@ interface ReceiptSentEnvelope {
  * Triggered when a receipt is sent.
  * @permissionScope Manage Receipts
  * @permissionScopeId SCOPE.RECEIPTS.MANAGE
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionId RECEIPTS.RECEIPT_READ
  * @webhook
  * @eventType wix.receipts.v1.receipt_sent
@@ -1282,8 +1328,6 @@ interface ReceiptUpdatedEnvelope {
  * Triggered when a receipt's number allocation is updated or a receipt document is generated.
  * @permissionScope Manage Receipts
  * @permissionScopeId SCOPE.RECEIPTS.MANAGE
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionId RECEIPTS.RECEIPT_READ
  * @webhook
  * @eventType wix.receipts.v1.receipt_updated
@@ -1409,7 +1453,79 @@ interface ReceiptsQueryBuilder {
  * @fqn wix.receipts.v1.Receipts.QueryReceipts
  * @requiredField query
  */
-declare function typedQueryReceipts(query: CursorQuery): Promise<NonNullablePaths<QueryReceiptsResponse, `receipts` | `receipts.${number}.numbering.displayNumber` | `receipts.${number}.regionalProperties.locale.languageCode` | `receipts.${number}.currency` | `receipts.${number}.sourceReference.wixPaymentOrder.orderId` | `receipts.${number}.sourceReference.wixPaymentOrder.transactionId` | `receipts.${number}.sourceReference.wixEcomOrder.orderId` | `receipts.${number}.sourceReference.wixEcomOrder.transactionId` | `receipts.${number}.sourceReference.appId` | `receipts.${number}.sourceReference.externalReferenceId` | `receipts.${number}.sourceReference.receiptOrderType` | `receipts.${number}.shippingInfo.title` | `receipts.${number}.shippingInfo.priceBeforeTax` | `receipts.${number}.shippingInfo.priceAfterTax` | `receipts.${number}.payment.paymentMethod` | `receipts.${number}.payment.amount` | `receipts.${number}.document.status`, 6>>;
+declare function typedQueryReceipts(query: ReceiptQuery): Promise<NonNullablePaths<QueryReceiptsResponse, `receipts` | `receipts.${number}.numbering.displayNumber` | `receipts.${number}.regionalProperties.locale.languageCode` | `receipts.${number}.currency` | `receipts.${number}.sourceReference.wixPaymentOrder.orderId` | `receipts.${number}.sourceReference.wixPaymentOrder.transactionId` | `receipts.${number}.sourceReference.wixEcomOrder.orderId` | `receipts.${number}.sourceReference.wixEcomOrder.transactionId` | `receipts.${number}.sourceReference.appId` | `receipts.${number}.sourceReference.externalReferenceId` | `receipts.${number}.sourceReference.receiptOrderType` | `receipts.${number}.shippingInfo.title` | `receipts.${number}.shippingInfo.priceBeforeTax` | `receipts.${number}.shippingInfo.priceAfterTax` | `receipts.${number}.payment.paymentMethod` | `receipts.${number}.payment.amount` | `receipts.${number}.document.status`, 6>>;
+interface ReceiptQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: [
+                '_createdDate',
+                '_id',
+                '_updatedDate',
+                'numbering.number',
+                'numbering.prefix',
+                'numbering.suffix',
+                'sourceReference.appId',
+                'sourceReference.externalReferenceId',
+                'sourceReference.wixEcomOrder.transactionId',
+                'sourceReference.wixPaymentOrder.transactionId'
+            ];
+            operators: '*';
+            sort: 'BOTH';
+        },
+        {
+            fields: ['numbering.displayNumber'];
+            operators: [];
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Receipt, ReceiptQuerySpec>;
+type ReceiptQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object in the following format:
+    `"filter" : {
+    "fieldName1": "value1",
+    "fieldName2":{"$operator":"value2"}
+    }`
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object in the following format:
+    `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * Retries generating a receipt document that has a `FAILED` or stuck in `PROCESSING` status.
  *
@@ -1488,4 +1604,4 @@ interface UpdateExtendedFieldsOptions {
     namespaceData: Record<string, any> | null;
 }
 
-export { type ActionEvent, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type AddressStreetOneOf, type BaseEventMetadata, type BusinessDetails, type CreateReceiptApplicationErrors, type CreateReceiptRequest, type CreateReceiptResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type CustomFields, type Customer, type Discount, type Document, DocumentStatus, type DocumentStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type Failed, type FooterCustomField, type FullAddressContactDetails, type GenerateReceiptDocument, type GetLatestReceiptNumberOptions, type GetLatestReceiptNumberRequest, type GetLatestReceiptNumberResponse, type GetReceiptRequest, type GetReceiptResponse, type IdentificationData, type IdentificationDataIdOneOf, type LineItem, type LineItemTax, type LineItemTotals, type Locale, type MessageEnvelope, type Numbering, type Payment, type QueryReceiptsRequest, type QueryReceiptsResponse, type Receipt, type ReceiptCreatedEnvelope, type ReceiptDocumentHandled, type ReceiptDocumentHandledResultOneOf, type ReceiptDocumentProcess, type ReceiptNumberingProcess, ReceiptOrderType, type ReceiptOrderTypeWithLiterals, type ReceiptSentEnvelope, type ReceiptUpdatedEnvelope, type ReceiptsQueryBuilder, type ReceiptsQueryResult, type RegenerateReceiptDocumentApplicationErrors, type RegenerateReceiptDocumentRequest, type RegenerateReceiptDocumentResponse, type RegionalProperties, RequestOrigin, type RequestOriginWithLiterals, type RestoreInfo, type SendReceiptEmailApplicationErrors, type SendReceiptEmailOptions, type SendReceiptEmailRequest, type SendReceiptEmailResponse, type Sent, type ShippingAddressContactDetails, type ShippingInfo, type ShippingTax, SortOrder, type SortOrderWithLiterals, type Sorting, type SourceReference, type SourceReferenceOrderOneOf, type StandardDetails, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Succeeded, type Tax, type Totals, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateReceiptRequest, type UpdateReceiptResponse, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixEcom, type WixPayment, createReceipt, getLatestReceiptNumber, getReceipt, onReceiptCreated, onReceiptSent, onReceiptUpdated, queryReceipts, regenerateReceiptDocument, sendReceiptEmail, typedQueryReceipts, updateExtendedFields };
+export { type ActionEvent, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type AddressStreetOneOf, type BaseEventMetadata, type BusinessDetails, type CommonQueryWithEntityContext, type CreateReceiptApplicationErrors, type CreateReceiptRequest, type CreateReceiptResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type CustomFields, type Customer, type Discount, type Document, DocumentStatus, type DocumentStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type Failed, type FooterCustomField, type FullAddressContactDetails, type GenerateReceiptDocument, type GetLatestReceiptNumberOptions, type GetLatestReceiptNumberRequest, type GetLatestReceiptNumberResponse, type GetReceiptRequest, type GetReceiptResponse, type IdentificationData, type IdentificationDataIdOneOf, type LineItem, type LineItemTax, type LineItemTotals, type Locale, type MessageEnvelope, type Numbering, type Payment, type QueryReceiptsRequest, type QueryReceiptsResponse, type Receipt, type ReceiptCreatedEnvelope, type ReceiptDocumentHandled, type ReceiptDocumentHandledResultOneOf, type ReceiptDocumentProcess, type ReceiptNumberingProcess, ReceiptOrderType, type ReceiptOrderTypeWithLiterals, type ReceiptQuery, type ReceiptQuerySpec, type ReceiptSentEnvelope, type ReceiptUpdatedEnvelope, type ReceiptsQueryBuilder, type ReceiptsQueryResult, type RegenerateReceiptDocumentApplicationErrors, type RegenerateReceiptDocumentRequest, type RegenerateReceiptDocumentResponse, type RegionalProperties, RequestOrigin, type RequestOriginWithLiterals, type RestoreInfo, type SendReceiptEmailApplicationErrors, type SendReceiptEmailOptions, type SendReceiptEmailRequest, type SendReceiptEmailResponse, type Sent, type ShippingAddressContactDetails, type ShippingInfo, type ShippingTax, SortOrder, type SortOrderWithLiterals, type Sorting, type SourceReference, type SourceReferenceOrderOneOf, type StandardDetails, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Succeeded, type Tax, type Totals, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateReceiptRequest, type UpdateReceiptResponse, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixEcom, type WixPayment, createReceipt, getLatestReceiptNumber, getReceipt, onReceiptCreated, onReceiptSent, onReceiptUpdated, queryReceipts, regenerateReceiptDocument, sendReceiptEmail, typedQueryReceipts, updateExtendedFields };