Mutation

(OBJECT)

set of methods and entities to create and/or modify entities with this API.

link GraphQL Schema definition

  • type Mutation {
  • # creates a preinvoice (payment request) for an order
  • #
  • # Arguments
  • # order_num: order's evidence number for which to create
  • # preinvoice
  • # send_notification: possibility to tweak default system behavior
  • # or send multiple notifications
  • preinvoiceOrder(
  • order_num: String!,
  • send_notification: [NotificationRequest!]
  • ): Preinvoice
  • # creates final invoice for preinvoice
  • #
  • # Arguments
  • # preinvoice_num: preinvoice (payment request's) evidence number
  • # send_notification: possibility to tweak default system behavior
  • # or send multiple notifications
  • finalizeInvoice(
  • preinvoice_num: String!,
  • send_notification: [NotificationRequest!]
  • ): Invoice
  • # sets order status
  • #
  • # Arguments
  • # order_num: order's evidence number for which to change the
  • # status
  • # status_id: system's internal status' id
  • # send_notification: possibility to tweak default system behavior
  • # or send multiple notifications
  • changeOrderStatus(
  • order_num: String!,
  • status_id: Int!,
  • send_notification: [NotificationRequest!]
  • ): Order
  • # change status, quantity of warehouse item
  • #
  • # Arguments
  • # warehouse_item:
  • # send_notification:
  • updateWarehouseItem(
  • warehouse_item: WarehouseItemInput!,
  • send_notification: [NotificationRequest!]
  • ): WarehouseItem
  • # create new order
  • #
  • # Arguments
  • # data:
  • newOrder(data: OrderInput!): Order
  • # payment of the invoice/preinvoice and creation of a receipt
  • #
  • # Arguments
  • # payment_reference: payment reference identificator
  • # reference_type: reference type e.g. preinvoice number, invoice
  • # number or variable_symbol
  • # payment_type: payment type identificator
  • # amount: total amount of payment
  • # pay_date: payment date
  • recordPayment(
  • payment_reference: String!,
  • reference_type: PaymentReferenceType!,
  • payment_type: PaymentType!,
  • amount: PriceInput!,
  • pay_date: Date!
  • ): Receipt
  • }

link Require by

This element is not required by anyone