Variable taxInvoiceExportStatusChangeConst

Type Declaration

• Readonly$ref: "#/definitions/Notification"

• Readonlydefinitions: {
      Notification: {
          properties: {
              eventTime: {
                  description: "The date and time when the notification event occurred, in ISO 8601 format.";
                  type: "string";
              };
              notificationMetadata: {
                  $ref: "#/definitions/NotificationMetadata";
                  description: "The notification's metadata, including the publish time and the application, subscription, and notification event identifiers.";
                  type: "object";
              };
              notificationType: {
                  description: "The notification type.";
                  enum: readonly ["TAX_INVOICE_EXPORT_STATUS_CHANGE"];
                  type: "string";
              };
              notificationVersion: {
                  description: "The version for this notification type.";
                  type: "string";
              };
              payload: {
                  $ref: "#/definitions/Payload";
                  description: "Event details about the change to the tax invoice export status.";
                  type: "object";
              };
              payloadVersion: {
                  description: "The version for this payload.";
                  type: "string";
              };
          };
          required: readonly [
              "notificationVersion",
              "notificationType",
              "payloadVersion",
              "eventTime",
              "payload",
              "notificationMetadata",
          ];
          type: "object";
      };
      NotificationMetadata: {
          properties: {
              applicationId: {
                  description: "The application identifier.";
                  type: "string";
              };
              notificationId: {
                  description: "The notification identifier.";
                  type: "string";
              };
              publishTime: {
                  description: "The date and time when the notification was published, in ISO 8601 format.";
                  type: "string";
              };
              subscriptionId: {
                  description: "The subscription identifier.";
                  type: "string";
              };
          };
          required: readonly [
              "applicationId",
              "subscriptionId",
              "publishTime",
              "notificationId",
          ];
          type: "object";
      };
      Payload: {
          properties: {
              exportId: {
                  description: "The identifier for the export request. This value is returned by the `createInvoicesExport` operation.";
                  type: "string";
              };
              marketplaceId: {
                  description: "The identifier for the store where the invoice applies.";
                  type: "string";
              };
              status: {
                  description: "The status of the export request. Possible values: REQUESTED - The export has been received. PROCESSING - The export is being generated. DONE - The export is complete and available for download. ERROR - The export failed.";
                  enum: readonly ["DONE", "ERROR", "REQUESTED", "PROCESSING"];
                  type: "string";
              };
          };
          required: readonly ["marketplaceId", "exportId", "status"];
          type: "object";
      };
  }

• Readonlydescription: "The response schema for notifications sent when a tax invoice export status changes."

• Readonlytype: "object"