/accounting

The collection of Invoices

get

Get a list of all Invoice objects.

The collection of Invoices.

get

Get a single Invoice record.

The collection of CustomerInvoices

get

Get a list of all CustomerInvoice objects.

post

Creating customer invoices which are not related to an order or a product.

The collection of CustomerInvoices.

get

Get a single CustomerInvoice record.

patch

Update details for a draft customer invoice.

delete

Delete a draft customer invoice.

The Contact record associated with the parent record.

post

Create a new Contact record.

patch

Update details for a contact.

The Address record associated with the parent record.

post

Create a new Address record.

patch

Update details for an address.

The collection of LineItems

get

Get a list of all LineItem objects.

post

Create a new LineItem object.

The collection of LineItems.

get

Get a single LineItem record.

patch

Update details for a line item.

delete

Delete a line item for draft customer invoice.

The PaymentTerms record associated with the parent record.

post

Create a new PaymentTerm record.

patch

Update details for payment terms.

The ReversalInvoice record associated with the parent record.

post

Cancel a billed customer invoice and create a reversal invoice.

The collection of CreditNotes

get

Get a list of all CreditNote objects.

post

Create a new CreditNote object.

The collection of CreditNotes.

get

Get a single CreditNote record.

patch

Update details for a draft credit note.

delete

Delete a draft credit note.

The Contact record associated with the parent record.

post

Create a new Contact record.

patch

Update details for a contact.

The Address record associated with the parent record.

post

Create a new Address record.

patch

Update details for an address.

The collection of LineItems

get

Get a list of all LineItem objects.

post

Create a new LineItem object.

The collection of LineItems.

get

Get a single LineItem record.

patch

Update details for a line item.

delete

Delete a line item for draft credit note.

The collection of ReversalInvoices

get

Get a list of all ReversalInvoice objects.

The collection of ReversalInvoices.

get

Get a single ReversalInvoice record.

/customer_relations

The collection of Organizations

get

Get a list of all Organization objects.

post

Create a new Organization object.

The collection of Organizations.

get

Get a single Organization record.

patch

Update the given Organization record with provided data.

The collection of People

get

Get a list of all Person objects.

post

Create a new Person object.

The collection of People.

get

Get a single Person record.

patch

Update the given Person record with provided data.

delete

Delete the given Person record.

/configuration

The collection of BusinessUnits

get

Get a list of all BusinessUnit objects.

The collection of BusinessUnits.

get

Get a single BusinessUnit record.

The collection of Carriers

get

Get a list of all Carrier objects.

post

Create a new Carrier object.

The collection of Carriers.

get

Get a single Carrier record.

patch

Update the given Carrier record with provided data.

delete

Delete the given Carrier record.

The collection of StockFinishings

get

Get a list of all StockFinishing objects.

The collection of StockSubstrates

get

Get a list of all StockSubstrate objects.

post

Create a new StockSubstrate object.

The collection of StockSubstrates.

get

Get a single StockSubstrate record.

patch

Update the given StockSubstrate record with provided data.

delete

Delete the given StockSubstrate record.

get

Returns all product templates that are available in the current printery.

get

Returns all service templates that are available in the current printery. Services can be added to a product, to denote that this product needs certain services performed, e.g. 'typesetting', in order to be fully produced.

get

Returns all printery-wide settings.

/sales

The collection of Orders

get

Get a list of all orders in draft state, that is orders that haven't been confirmed by their customer yet, and for which production hasn't started yet.

post

Create a new Order object.

The collection of Orders.

get

Get details for a single order, which is in draft state, that is it hasn't been confirmed by it's customer yet and production of the order hasn't started yet.

patch

Update details for a single draft order.

delete

Delete a draft order.

The Address record associated with the parent record.

post

Create a new Address record.

patch

Update details for an address.

The collection of Products

get

Get a list of all Product objects.

post

Create a new Product object.

/conception

The collection of Products.

get

Get details for a single product, which is in draft state, that is the order it belongs to hasn't been confirmed by it's customer yet and production hasn't started yet.

delete

Delete a product in draft state.

patch

Update the given Product record with provided data.

The collection of PrintDataFiles

get

Get a list of all PrintDataFile objects.

post

Create a new PrintDataFile object.

The collection of PrintDataFiles.

get

Get a single PrintDataFile record.

patch

Update the given PrintDataFile record with provided data.

delete

Delete the given PrintDataFile record.

The collection of Finishings

get

Get a list of all Finishing objects.

post

Create a new Finishing object.

The collection of Finishings.

get

Get a single Finishing record.

delete

Delete the given Finishing record.

The collection of FinishingProperties

get

Get a list of all FinishingProperty objects.

The collection of FinishingProperties.

get

Get a single FinishingProperty record.

patch

Update the given FinishingProperty record with provided data.

Returns all stock finishings that are available only for products or products and components.

get

Get a list of all StockFinishing objects.

The collection of Components

get

Get a list of all Component objects.

post

Create a new Component object.

The collection of Components.

get

Get a single Component record.

patch

Update the given Component record with provided data.

delete

Delete the given Component record.

The collection of Finishings

get

Get a list of all Finishing objects.

post

Create a new Finishing object.

The collection of Finishings.

get

Get a single Finishing record.

delete

Delete the given Finishing record.

The collection of FinishingProperties

get

Get a list of all FinishingProperty objects.

The collection of FinishingProperties.

get

Get a single FinishingProperty record.

patch

Update the given FinishingProperty record with provided data.

The collection of Imposings

get

Get a list of all Imposing objects.

The collection of Imposings.

get

Get a single Imposing record.

patch

Update the given Imposing record with provided data.

The Substrate record associated with the parent record.

get

Get the Substrate record.

post

Create a new Substrate record.

patch

Update the given Substrate record with provided data.

delete

Delete the given Substrate record.

The collection of PrintDataFiles

get

Get a list of all PrintDataFile objects.

post

Create a new PrintDataFile object.

The collection of PrintDataFiles.

get

Get a single PrintDataFile record.

patch

Update the given PrintDataFile record with provided data.

delete

Delete the given PrintDataFile record.

Returns all stock finishings that are available only for components or products and components.

get

Get a list of all StockFinishing objects.

The DesiredSubstrateProperties record associated with the parent record.

get

Get the DesiredSubstrateProperty record.

patch

Update the given DesiredSubstrateProperty record with provided data.

The collection of ProductionPaths

get

Get a list of all ProductionPath objects.

post

Create a new ProductionPath object.

The collection of ProductionPaths.

get

Get a single ProductionPath record.

patch

Update the given ProductionPath record with provided data.

delete

Delete the given ProductionPath record.

patch

Conceptualize the production path.

The collection of Circulations

get

Get a list of all Circulation objects.

The collection of Circulations.

get

Get a single Circulation record.

patch

Update the given Circulation record with provided data.

The collection of Variants

get

Get a list of all Variant objects.

post

Create a new Variant object.

The collection of Variants.

get

Get a single Variant record.

patch

Update the given Variant record with provided data.

delete

Delete the given Variant record.

The collection of Services

get

Get a list of all Service objects.

post

Create a new Service object.

The collection of Services.

get

Get a single Service record.

patch

Update the given Service record with provided data.

delete

Delete the given Service record.

The collection of Packagings

get

Get a list of all Packaging objects.

post

Create a new Packaging object.

The collection of Packagings.

get

Get a single Packaging record.

patch

Update the given Packaging record with provided data.

delete

Delete the given Packaging record.

The collection of Picks

get

Get a list of all Pick objects.

post

Create a new Pick object.

The collection of Picks.

get

Get a single Pick record.

patch

Update the given Pick record with provided data.

delete

Delete the given Pick record.

The Shipment record associated with the parent record.

get

Get the Shipment record.

post

Create a new Shipment record.

delete

Delete the given Shipment record.

The Address record associated with the parent record.

get

Get the Address record.

post

Create a new Address record.

delete

Delete the given Address record.

/production

The collection of Tasks

get

Get a list of all Task objects.

The collection of Tasks.

get

Get a single Task record.

patch

Update the given Task record with provided data.

delete

Set a task to canceled.

The collection of TaskExecutions

get

Get a list of all TaskExecution objects.

post

Create a new TaskExecution object.

The collection of TaskExecutions.

patch

Update the given TaskExecution record with provided data.

The collection of MaterialDemands

get

Get a list of all MaterialDemand objects.

post

Create a new MaterialDemand object.

The collection of MaterialDemands.

patch

Update the given MaterialDemand record with provided data.

The collection of Tasks

get

Get a list of all Task objects.

The endpoint will return an error 400 if the required POST data is missing or error 422 if the submitted value is no Integer value. Error code 422 is also returned if the selected means of production has no currently running tasks - this is required to update the counters.

The counter value is expected to represent the number of new counts within any recent time interval. Thus it will be added to the current values of the task (or to multiple tasks if multiple are running on this means of production). To which of the task counters the value will be added depends:

  • if only a task execution in the phase „execution“ is present for the task, the counter „actual_amount_of_manufactured_products“ will be incremented
  • if a task execution in the phase „preparations“, the counter „actual_amount_of_wasted_manufactured_products“ will be incremented, should there as well exist a task execution in the phase „execution“, this one will be ignored and only the wasted counter will be updated

This logic will happen for all tasks that are currently running on the named means of production.

On a successful request the API will return status 200 with an empty response.

post

The ProductionPath record associated with the parent record.

get

Get the ProductionPath record.

/warehouse

The collection of Materials

get

Get a list of all Material objects.

post

Create a new Material object.

The collection of Materials.

get

Get a single Material record.

patch

Update the given Material record with provided data.

delete

Delete the given Material record.

The collection of StorageAreas

get

Get a list of all StorageArea objects.

post

Create a new StorageArea object.

The collection of StorageAreas.

get

Get a single StorageArea record.

patch

Update the given StorageArea record with provided data.

delete

Delete the given StorageArea record.

The collection of MaterialTransfers

get

Get a list of all MaterialTransfer objects.

post

Create a new MaterialTransfer object.