@restorecommerce/protos 3.1.1 → 4.0.0

package/io/restorecommerce/invoice.proto

@@ -2,16 +2,23 @@ syntax = "proto3";
 
 package io.restorecommerce.invoice;
 
+import "google/protobuf/any.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/organization.proto";
 import "io/restorecommerce/auth.proto";
-import "google/protobuf/any.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
+import "io/restorecommerce/address.proto";
+import "io/restorecommerce/amount.proto";
+import "io/restorecommerce/price.proto";
+import "io/restorecommerce/file.proto";
+import "io/restorecommerce/reference.proto";
 
 // Used by resolvers
+import "io/restorecommerce/user.proto";
 import "io/restorecommerce/customer.proto";
+import "io/restorecommerce/shop.proto";
 
 /*
 * Microservice definition.
@@ -21,28 +28,50 @@ service InvoiceService {
     option (io.restorecommerce.options.is_query) = true;
   };
   rpc Create (InvoiceList) returns (InvoiceListResponse);
-  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (InvoiceList) returns (InvoiceListResponse);
   rpc Upsert (InvoiceList) returns (InvoiceListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+
+  /*
+  * Render invoices as PDF to ostorage. (creates if not exist, updates if id is given)
+  */
+  rpc Render (InvoiceList) returns (InvoiceListResponse);
+  
+  /*
+  * Mark invoices as withdrawn
+  */
+  rpc Withdraw (InvoiceIdList) returns (InvoiceListResponse);
+
+  /*
+  * Triggers notification-srv (sends invoice per email for instance) 
+  */
+  rpc Send (InvoiceIdList) returns (io.restorecommerce.status.StatusListResponse);
+
+  /*
+  * Generate an incremented invoice number
+  */
   rpc GenerateInvoiceNumber(RequestInvoiceNumber) returns (InvoiceNumberResponse);
 }
 
+enum PaymentState {
+  UNPAYED = 0;
+  PAYED = 1;
+}
+
 message RequestInvoiceNumber {
- google.protobuf.Any context = 1;
- io.restorecommerce.auth.Subject subject = 3;
+  optional string shop_id = 1;
+  google.protobuf.Any context = 2;
+  io.restorecommerce.auth.Subject subject = 3;
 }
 
 message InvoiceNumberResponse {
- string invoice_no = 1;
+ string invoice_number = 1;
 }
 
 message Deleted {
   string id = 1;
 }
 
-/*
-* For multiple invoices
-*/
 message InvoiceList {
   repeated Invoice items = 1;
   optional uint32 total_count = 2;
@@ -60,14 +89,45 @@ message InvoiceResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
+message InvoiceId {
+  optional string id = 1;
+  repeated string channel_ids = 2;
+  optional google.protobuf.Any options = 3;
+  optional io.restorecommerce.auth.Subject subject = 4;
+}
+
+message InvoiceIdList {
+  repeated InvoiceId items = 1;
+  optional uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
 /*
-* A simple invoice.
+* The Invoice recource, stored in DB.
 */
 message Invoice {
+  option (restorecommerce.options.kafka_subscriber) = {
+    plural: "invoices"
+    topic: "io.restorecommerce.invoice.resource"
+    created: "invoiceCreated"
+    updated: "invoiceUpdated"
+    deleted: "invoiceDeleted"
+  };
+
   optional string id = 1;
   optional io.restorecommerce.meta.Meta meta = 2;
-  optional string timestamp = 4;
-  optional string customer_id = 5 [
+  optional string invoice_number = 3;
+  repeated io.restorecommerce.reference.Reference references = 4; 
+  optional string user_id = 5 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.user.User",
+      target_service: "identity",
+      target_sub_service: "user",
+      target_method: "Read",
+      field_name: "user",
+    }
+  ];
+  optional string customer_id = 6 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.customer.Customer",
       target_service: "resource",
@@ -75,77 +135,64 @@ message Invoice {
       target_method: "Read",
       field_name: "customer",
     }
-  ];
-  optional string payment_status = 6;
-  optional double total_amount = 7;
-  optional double net_amount = 8;
-  optional double vat_amount = 9; // difference between net and total
-  optional string document = 10;
-  optional string invoice_number = 11;
-  optional string customer_remark = 12;
-}
-
-/**
-* List of Invoice Positions data
-*/
-message InvoicesPositionsData {
-  repeated InvoicePositions invoice_positions = 1;
-}
-
-message InvoicePositions {
-  optional string id = 1; // contract or customer identifier
-  repeated InvoicePosition invoice_positions = 2;
-  optional RecipientCustomer recipient_customer = 3;
-  optional BillingAddress recipient_billing_address = 4;
-  optional BillingAddress sender_billing_address = 5;
-  optional io.restorecommerce.organization.Organization recipient_organization = 6;
-  optional io.restorecommerce.organization.Organization sender_organization = 7;
-  optional google.protobuf.Any payment_method_details = 8;
-  optional string invoice_no = 9; // optional invoice number if not it will be generated by service
-  optional double from_date = 10; // value performance from date
-  optional double to_date = 11; // value performance to date
-}
-
-message RecipientCustomer {
-  optional string id = 1; // customer id - used to store the resource in DB
-  optional string customer_number = 2; // displayed in invoice
-}
-
-message BillingAddress {
-  optional string email = 1;
-  optional string website = 2;
-  optional string street = 3;
-  optional string building_number = 4;
-  optional string postcode = 5;
-  optional string region = 6;
-  optional string country_name = 7;
-  optional string telephone = 9;
-  optional string timezone = 10;
-  optional string economic_area = 11;
-  optional string locality = 12;
-  optional string organization_name = 13;
-}
-
-message InvoicePosition {
-  optional string currency = 1;
-  repeated InvoiceRow invoiceRows = 2;
-  optional InvoicePrice totalPrice = 3;
-}
-
-message InvoiceRow {
-  optional string product = 1;
-  optional double pricePerUnit = 2;
-  optional uint32 quantity = 3;
-  optional string vat = 4;
-  optional double amount = 5;
-  optional double contract_start_date = 6; // if there is any contract associated with product
+  ]; // customer_number ref. to recipent orga
+  optional string shop_id = 7 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.shop.Shop",
+      target_service: "resource",
+      target_sub_service: "shop",
+      target_method: "Read",
+      field_name: "shop",
+    }
+  ]; // shop_number --- ref. to sender orga
+  optional double timestamp = 8;
+  optional PaymentState payment_state = 9;
+  optional io.restorecommerce.address.BillingAddress sender = 10;
+  optional io.restorecommerce.address.BillingAddress recipient = 11;
+  repeated Position positions = 12;
+  repeated io.restorecommerce.amount.Amount total_amounts = 13;
+  repeated string payment_hints = 14; // is there no better type for that?
+  repeated io.restorecommerce.file.File documents = 15; // url to rendered PDFs
+  optional string customer_remark = 16;
+  optional double from_date = 17; // value performance from date
+  optional double to_date = 18; // value performance to date
+  optional bool sent = 19;
+  optional bool withdrawn = 20;
+}
+
+message Position {
+  optional string id = 1;
+  repeated Row rows = 3;
+  repeated io.restorecommerce.amount.Amount amounts = 5; // repeated in case of multiple currencies?
 }
 
-message InvoicePrice {
-  optional double gross = 1;
-  optional double net = 2;
+message Row {
+  optional string id = 1;
+  oneof item_type {
+    ProductItem product_item = 2;
+    ManualItem manual_item = 3;
+  }
+  optional io.restorecommerce.price.Price unit_price = 4;
+  optional uint32 quantity = 5;
+  optional io.restorecommerce.amount.Amount amount = 6;
+  optional double contract_start_date = 7; // if there is any contract associated with product
+}
+
+message ProductItem {
+  optional string product_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.product.Product",
+      target_service: "catalog",
+      target_sub_service: "product",
+      target_method: "Read",
+      field_name: "product",
+    }
+  ];
+  optional string variant_id = 2;
 }
 
-message TriggerInvoices {
-  repeated string ids = 1; // list of id referring to contract_ids or customer_ids
-}
+message ManualItem {
+  optional string stock_keeping_unit = 1;
+  optional string name = 2;
+  optional string descritpion = 3;
+}

package/io/restorecommerce/location.proto

@@ -55,7 +55,7 @@ message Location {
   optional string organization_id = 5 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "organization",
       target_method: "Read",
       field_name: "organization",
@@ -64,7 +64,7 @@ message Location {
   optional string parent_id = 6 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.location.Location",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "location",
       target_method: "Read",
       field_name: "parent",
@@ -73,7 +73,7 @@ message Location {
   optional string address_id = 8 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "address",
       target_method: "Read",
       field_name: "address",

package/io/restorecommerce/notification_req.proto

@@ -3,6 +3,7 @@ syntax = "proto3";
 package io.restorecommerce.notification_req;
 
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/reference.proto";
 
 service NotificationReqService {
   // direct notifications
@@ -35,6 +36,7 @@ message NotificationReq {
   optional string transport = 5; /// 'email', 'log', ... default == 'log'
   optional string provider = 6; /// specific transport provider, eg: 'console' for transport == 'log'
   repeated Attachment attachments = 7;
+  optional io.restorecommerce.reference.Reference reference = 8;
 }
 
 message Email {

package/io/restorecommerce/order.proto

@@ -2,16 +2,23 @@ syntax = "proto3";
 
 package io.restorecommerce.order;
 
+import "google/protobuf/any.proto";
+
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 import "io/restorecommerce/address.proto";
-import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/amount.proto";
+import "io/restorecommerce/price.proto";
 import "io/restorecommerce/country.proto";
 import "io/restorecommerce/fulfillment.proto";
 import "io/restorecommerce/fulfillment_product.proto";
+import "io/restorecommerce/invoice.proto";
+
+// Used by resolvers
+import "io/restorecommerce/shop.proto";
 
 
 service OrderService {
@@ -26,34 +33,46 @@ service OrderService {
   rpc Withdraw (OrderIdList) returns (OrderListResponse);
   rpc Cancel (OrderIdList) returns (OrderListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
-  
+
   // Requires Fulfillment Service
   rpc QueryPackingSolution (FulfillmentRequestList) returns (io.restorecommerce.fulfillment_product.PackingSolutionListResponse);
   // Requires Fulfillment Service
   rpc CreateFulfillment (FulfillmentRequestList) returns (io.restorecommerce.fulfillment.FulfillmentListResponse);
   // Requires Fulfillment Service
   rpc TriggerFulfillment (FulfillmentRequestList) returns (io.restorecommerce.status.StatusListResponse);
+
+  // Requires Invoice Service
+  rpc CreateInvoice (InvoiceRequestList) returns (io.restorecommerce.invoice.InvoiceListResponse);
+  // Requires Invoice Service
+  rpc TriggerInvoice (InvoiceRequestList) returns (io.restorecommerce.status.StatusListResponse);
 }
 
-enum OrderState {
-  Created = 0;
-  Submitted = 1;
-  Confirmed = 2;
-  Invalid = 3;
-  Shipping = 4;
-  Failed = 5;
-  Done = 6;
-  Withdrawn = 7;
-  Cancelled = 8;
+enum State {
+  FAILED = 0;
+  INVALID = 1;
+  CREATED = 2;
+  SUBMITTED = 3;
+  IN_PROCESS = 4;
+  DONE = 5;
+  WITHDRAWN = 6;
+  CANCELLED = 7;
 }
 
-message OrderItem {
-  optional string product_id = 1;
-  optional string variant_id = 2;
-  optional int32 quantity = 3;
-  optional double unit_price = 4; //Set by service
-  optional double price = 5; //Set by service
-  repeated io.restorecommerce.tax.VAT vats = 6; //Set by service
+message Item {
+  optional string id = 1;
+  optional string product_id = 2 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.product.Product",
+      target_service: "catalog",
+      target_sub_service: "product",
+      target_method: "Read",
+      field_name: "product",
+    }
+  ];
+  optional string variant_id = 3;
+  optional int32 quantity = 4;
+  optional io.restorecommerce.price.Price unit_price = 5; //Set by service
+  optional io.restorecommerce.amount.Amount amount = 6; //Set by service
 }
 
 /**
@@ -70,16 +89,44 @@ message Order {
 
   optional string id = 1;
   optional io.restorecommerce.meta.Meta meta = 2;
-  optional OrderState state = 3;
-  optional string customer_reference = 4;
-  repeated OrderItem items = 5;
-  optional double total_price = 6; //Set by service
-  optional double total_vat = 7; //Set by service
-  optional io.restorecommerce.address.ShippingAddress shipping_address = 8;
-  optional io.restorecommerce.address.ShippingAddress billing_address = 9;
-  optional string billing_email = 10;
-  optional string notification_email = 11;
-  optional io.restorecommerce.fulfillment_product.Preferences packing_preferences = 12;
+  optional string user_id = 3 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.customer.Customer",
+      target_service: "resource",
+      target_sub_service: "customer",
+      target_method: "Read",
+      field_name: "customer",
+    }
+  ];
+  optional string customer_id = 4 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.customer.Customer",
+      target_service: "resource",
+      target_sub_service: "customer",
+      target_method: "Read",
+      field_name: "customer",
+    }
+  ];
+  optional string shop_id = 5 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.shop.Shop",
+      target_service: "resource",
+      target_sub_service: "shop",
+      target_method: "Read",
+      field_name: "shop",
+    }
+  ];
+  repeated Item items = 6;
+  optional State order_state = 7;                                         // Set by service
+  optional io.restorecommerce.fulfillment.State fulfillment_state = 8;    // Set by kafka
+  optional io.restorecommerce.invoice.PaymentState payment_state = 9;            // Set by kafka
+  repeated io.restorecommerce.amount.Amount total_amounts = 10;                // Set by service --- repeated in case of variant currency?
+  optional io.restorecommerce.address.ShippingAddress shipping_address = 11;
+  optional io.restorecommerce.address.BillingAddress billing_address = 12;
+  optional string notification_email = 13;
+  optional string customer_order_nr = 14;
+  optional string customer_remark = 15;
+  optional io.restorecommerce.fulfillment_product.Preferences packaging_preferences = 16;
 }
 
 message OrderIdList {
@@ -108,20 +155,35 @@ message Deleted {
   string id = 1;
 }
 
-message ShippingDetails {
-  optional string export_type = 1;
-  optional string export_description = 2;
-  optional string invoice_number = 3;
-  optional io.restorecommerce.address.ShippingAddress sender_address = 4;
-}
-
 message FulfillmentRequest {
-  optional string reference_id = 1;
-  optional ShippingDetails shipping_details = 2;
+  optional string order_id = 1;
+  optional string export_type = 2; // @TODO: not used!
+  optional string export_description = 3; // @TODO: not used!
+  optional string invoice_number = 4; // @TODO: not used!
+  optional io.restorecommerce.address.ShippingAddress sender_address = 5;
+  repeated string include_items = 6; // includes all if empty
+  google.protobuf.Any data = 7;
 }
 
 message FulfillmentRequestList {
   repeated FulfillmentRequest items = 1;
   optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
-}
+}
+
+message InvoicePosition {
+  optional string order_id = 2;
+  repeated string included_items = 3; // includes all on empty
+  repeated string included_fulfillments = 4; // includes all on empty
+}
+
+message InvoiceRequest {
+  optional string invoice_number = 1; // if given
+  repeated InvoicePosition positions = 2;
+}
+
+message InvoiceRequestList {
+  repeated InvoiceRequest items = 1;
+  optional uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}

package/io/restorecommerce/organization.proto

@@ -53,41 +53,32 @@ message OrganizationResponse {
 message Organization {
   optional string id = 1; /// Organization ID, unique, key
   optional io.restorecommerce.meta.Meta meta = 2;
-  optional string address_id = 3 [
-    (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.address.Address",
-      target_service: "resource",
-      target_sub_service: "address",
-      target_method: "Read",
-      field_name: "address",
-    }
-  ]; /// Address for the organization
-  optional string parent_id = 4 [
+  optional string parent_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "organization",
       target_method: "Read",
       field_name: "parent",
     }
   ]; //  Hierarchically superior organization; may be null
-  repeated string contact_point_ids = 6 [
+  repeated string contact_point_ids = 4 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.contact_point.ContactPoint",
-      target_service: "resource",
+      target_service: "master_data",
       target_sub_service: "contact_point",
       target_method: "Read",
       field_name: "contactPoints",
     }
   ]; // list of possible legal addresses of different types
-  optional string website = 7;
-  optional string email = 8;
-  optional string logo = 9; // base64; arangoDB does not support blob storage
-  optional string vat_id = 10;
-  optional string isic_v4 = 11;
-  optional string registration = 12;
-  optional string registration_court = 13;
-  optional string name = 14;
-  repeated string payment_method_ids = 15;
-  optional google.protobuf.Any data = 16; /// additional data
+  optional string website = 5;
+  optional string email = 6;
+  optional string logo = 7; // base64; arangoDB does not support blob storage
+  optional string vat_id = 8;
+  optional string isic_v4 = 9;
+  optional string registration = 10;
+  optional string registration_court = 11;
+  optional string name = 12;
+  repeated string payment_method_ids = 13;
+  optional google.protobuf.Any data = 14; /// additional data
 }

package/io/restorecommerce/price.proto

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package io.restorecommerce.price;
+
+// Used by resolvers
+import "io/restorecommerce/options.proto";
+import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/currency.proto";
+
+message Price {
+  optional double regular_price = 1;
+  optional bool sale = 2;
+  optional double sale_price = 3;
+  optional string currency_id = 4 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.currency.Currency",
+      target_service: "master_data",
+      target_sub_service: "currency",
+      target_method: "Read",
+      field_name: "currency",
+    }
+  ];
+  repeated string tax_ids = 5 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.tax.Tax",
+      target_service: "master_data",
+      target_sub_service: "tax",
+      target_method: "Read",
+      field_name: "taxes",
+    }
+  ];
+}