Keyline API documentation version 2.0

https://app.keyline-mis.com/api/v2

API for interacting with Keyline, the modern Print MIS

Authentication

Keyline requires API users to authenticate before they can access any information, and leverages a bearer token based authentication scheme to secure access.

All valid requests to the Keyline API must therefore contain the Authorization header field, which contains a valid API key, prefixed with the string Bearer, so that the header line looks similar to the following:

Authorization: Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e

You can add or revoke access tokens in the Settings > API section of Keyline.

Response Paging

Responses to GET requests that hit index endpoints, such as /api/v2/configuration/customers will at most get back a result set of size 100. If the total size of the desired result set exceeds 100, multiple requests need to be made.

If a response's result set was paged, the response headers contain the following extra headers:

X-Keyline-Result-Page: Gives the page number of the current returned result subset
X-Keyline-Result-Per-Page: Gives the maximum size of the current returned result subset. Is always 100.
X-Keyline-Result-Total: Gives the total number of results across all pages.

If a client wants to fetch a page number different from the first, it must specify the page number as a request header X-Keyline-Requested-Page, where the value is the page to fetch as an integer. The lowest page number is always 1.

Status Codes

The Keyline API uses standardised HTTP response codes the inform the caller about the status of any requests.

These are the most common codes you'll get to see:

200 OK: Everything is okay
201 Created: You just created a new resource
204 No Content: The update or delete operation you just ran was successful
400 Bad request: The request you made is missing required parameters and cannot be executed
401 Unauthorized: You're not allowed to access this resource. Check your access token
404 Not found: You tried to access a resource that doesn't exist
422 Unprocessable Entity: The validation of the resource you wanted to create or change failed. The JSON will contain a detailed error description
500 Internal Server Error: Yikes! This is pretty bad and might be our fault. If you encounter one of these, we are automatically informed, but please contact us with some in-depth infos.

Encoding of Decimal Numbers

Keyline internally uses a number datatype (Ruby's BigDecimal) that allows for higher precision than the Javascript float datatype. In order to preserve this high level of precision and aim for highest compatibility of API clients consuming the JSON responses of the Keyline API, such numbers are encoded as strings in the JSON responses.

It is the obligation of the API clients to correctly parse decimal numbers that are encoded as strings in JSON responses.

/accounting

/accounting/invoices get

The collection of Invoices

get

Get a list of all Invoice objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Invoice

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

[{
"id": 31899,
"recipient_id": 57,
"recipient_type": "Organization",
"business_unit_id": 23,
"reversed_invoice_id": null,
"number": "190404001",
"net_total": 95000,
"gross_total": 113050,
"paid_at": null,
"custom_text": null,
"taxes": {
  "0.19": 18050
},
"due_at": "2019-05-04",
"billed_at": "2019-04-04",
"sent_at": null,
"custom_references": {},
"services_performed_at": "2019-04-04",
"type": "CustomerInvoice",
"created_at": "2019-04-04T13:47:27.320Z",
"updated_at": "2019-04-04T13:48:20.269Z",
"recipient": {
  "id": 57,
  "name": "Crispy Mountain GmbH",
  "tax_identifier": null,
  "email": null,
  "reference": "14323323",
  "debitor_identifier": "JDU39939",
  "creditor_identifier": null,
  "preferred_locale": "de",
  "credit_limit": null,
  "created_at": "2016-05-30T07:43:24.993Z",
  "updated_at": "2018-12-04T10:42:43.457Z"
},
"contact": {
  "id": 13963,
  "organization_id": 57,
  "salutation": "Herr",
  "name": "Krüger",
  "first_name": "Sebastian",
  "mobile": null,
  "phone": null,
  "fax": null,
  "tax_identifier": null,
  "email": "sk@crispymtn.com",
  "reference": "VNWXR8",
  "credit_limit": null,
  "debitor_identifier": null,
  "preferred_locale": "de",
  "created_at": "2018-09-18T08:35:57.858Z",
  "updated_at": "2018-12-19T11:51:19.549Z"
},
"address": {
  "id": 167354,
  "addressee": "Crispy 2",
  "street": "Emmerich-Josef-Str.",
  "number": "1A",
  "addition": null,
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE",
  "fingerprint": "0521f90b1906d16dc99a6023c4f3da2f",
  "created_at": "2019-04-04T13:47:27.324Z",
  "updated_at": "2019-04-04T13:47:27.324Z"
},
"line_items": [{
  "id": 49950,
  "invoice_id": 31899,
  "description": "Flyer Caritas\r\nFlyer 6 Seiten LD:\r\nSeiten: 6 (Wickelfalz)\r\nGeschlossenes Format: 100 × 210 mm\r\nOffenes Format: 297 × 210 mm (A4)\r\nPapier: BD matt\r\nGrammatur: 170 g/m²\r\nFarben: CMYK / CMYK\r\n\r\nAntwortkarte:\r\nSeiten: 2\r\nFormat: 148 × 95 mm\r\nPapier: LuxoSatin weiß\r\nGrammatur: 250 g/m²\r\nFarben: Schwarz / Schwarz\r\nWeiterverarbeitung: Eckrunden (Anzahl der Ecken: 4 Stück)\r\n\r\nWeiterverarbeitung: Einstecken (Beschreibung: Karte in Flyer, Anzahl einzusteckende Teile: 1 Stück)",
  "qty": 1000,
  "unit": "piece",
  "net_total": 95000,
  "created_at": "2019-04-04T13:47:27.333Z",
  "updated_at": "2019-04-04T13:47:52.830Z",
  "tax_rate": "0.19",
  "gross_total": "113050.0",
  "billable_id": 105589,
  "billable_type": "Product",
  "net": "95.0",
  "discount": "0.0",
  "discounted_net_total": 95000,
  "order_number": "PH-4Q-QR",
  "environmental_certifications": [],
  "accounting_categories": [{
    "name": "Erlöse 19% MwSt.",
    "number": "8400",
    "invoice_kind": "outward",
    "tax_rate": "0.19"
  }]
}],
"payment_terms": {
  "time_for_payment": 30,
  "time_for_first_cashback": 14,
  "first_cashback_discount": 0.03,
  "time_for_second_cashback": null,
  "second_cashback_discount": null
}
},
{
"id": 31192,
"recipient_id": 57,
"recipient_type": "Organization",
"business_unit_id": 23,
"reversed_invoice_id": null,
"number": "190328002",
"net_total": 90250,
"gross_total": 107398,
"paid_at": null,
"custom_text": "Ausgleichsabgabe 100,- Euro",
"taxes": {
  "0.19": 17148
},
"due_at": "2019-04-27",
"billed_at": "2019-03-28",
"sent_at": null,
"custom_references": {},
"services_performed_at": "2019-03-28",
"type": "CustomerInvoice",
"created_at": "2019-03-28T14:30:18.760Z",
"updated_at": "2019-03-28T14:30:49.519Z",
"recipient": {
  "id": 57,
  "name": "Crispy Mountain GmbH",
  "tax_identifier": null,
  "email": null,
  "reference": "14323323",
  "debitor_identifier": "JDU39939",
  "creditor_identifier": null,
  "preferred_locale": "de",
  "credit_limit": null,
  "created_at": "2016-05-30T07:43:24.993Z",
  "updated_at": "2018-12-04T10:42:43.457Z"
},
"contact": {
  "id": 178,
  "organization_id": 57,
  "salutation": "Herr",
  "name": "Prinz",
  "first_name": "Matthias",
  "mobile": null,
  "phone": null,
  "fax": null,
  "tax_identifier": null,
  "email": "mp@crispymtn.com",
  "reference": "1TAVSG",
  "credit_limit": null,
  "debitor_identifier": null,
  "preferred_locale": null,
  "created_at": "2017-09-12T08:39:22.803Z",
  "updated_at": "2017-09-12T08:39:22.803Z"
},
"address": {
  "id": 164275,
  "addressee": "Crispy 2",
  "street": "Emmerich-Josef-Str.",
  "number": "1A",
  "addition": null,
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE",
  "fingerprint": "0521f90b1906d16dc99a6023c4f3da2f",
  "created_at": "2019-03-28T14:30:18.763Z",
  "updated_at": "2019-03-28T14:30:18.763Z"
},
"line_items": [{
  "id": 48669,
  "invoice_id": 31192,
  "description": "Flyer Caritas\r\nSeiten: 2\r\nFormat: 100 × 210 mm\r\nPapier: LuxoSatin weiß\r\nGrammatur: 170 g/m²\r\nFarben: CMYK / CMYK",
  "qty": 950,
  "unit": "piece",
  "net_total": 90250,
  "created_at": "2019-03-28T14:30:18.768Z",
  "updated_at": "2019-03-28T14:30:34.890Z",
  "tax_rate": "0.19",
  "gross_total": "107398.0",
  "billable_id": 105851,
  "billable_type": "Product",
  "net": "95.0",
  "discount": "0.0",
  "discounted_net_total": 90250,
  "order_number": "T1-2M-WD",
  "environmental_certifications": [],
  "accounting_category": {
    "name": "Erlöse 19% MwSt.",
    "number": "8400",
    "invoice_kind": "outward",
    "tax_rate": "0.19"
  }
}],
"payment_terms": {
  "time_for_payment": 30,
  "time_for_first_cashback": 14,
  "first_cashback_discount": 0.03,
  "time_for_second_cashback": null,
  "second_cashback_discount": null
}
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/invoices/{invoice_id} get

The collection of Invoices.

get

Get a single Invoice record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

invoice_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

{
"id": 31899,
"recipient_id": 57,
"recipient_type": "Organization",
"business_unit_id": 23,
"reversed_invoice_id": null,
"number": "190404001",
"net_total": 95000,
"gross_total": 113050,
"paid_at": null,
"custom_text": null,
"taxes": {
"0.19": 18050
},
"due_at": "2019-05-04",
"billed_at": "2019-04-04",
"sent_at": null,
"custom_references": {},
"services_performed_at": "2019-04-04",
"type": "CustomerInvoice",
"created_at": "2019-04-04T13:47:27.320Z",
"updated_at": "2019-04-04T13:48:20.269Z",
"recipient": {
"id": 57,
"name": "Crispy Mountain GmbH",
"tax_identifier": null,
"email": null,
"reference": "14323323",
"debitor_identifier": "JDU39939",
"creditor_identifier": null,
"preferred_locale": "de",
"credit_limit": null,
"created_at": "2016-05-30T07:43:24.993Z",
"updated_at": "2018-12-04T10:42:43.457Z"
},
"contact": {
"id": 13963,
"organization_id": 57,
"salutation": "Herr",
"name": "Krüger",
"first_name": "Sebastian",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "sk@crispymtn.com",
"reference": "VNWXR8",
"credit_limit": null,
"debitor_identifier": null,
"preferred_locale": "de",
"created_at": "2018-09-18T08:35:57.858Z",
"updated_at": "2018-12-19T11:51:19.549Z"
},
"address": {
"id": 167354,
"addressee": "Crispy 2",
"street": "Emmerich-Josef-Str.",
"number": "1A",
"addition": null,
"zip_code": "55116",
"town": "Mainz",
"country_code": "DE",
"fingerprint": "0521f90b1906d16dc99a6023c4f3da2f",
"created_at": "2019-04-04T13:47:27.324Z",
"updated_at": "2019-04-04T13:47:27.324Z"
},
"line_items": [{
"id": 49950,
"invoice_id": 31899,
"description": "Flyer Caritas\r\nFlyer 6 Seiten LD:\r\nSeiten: 6 (Wickelfalz)\r\nGeschlossenes Format: 100 × 210 mm\r\nOffenes Format: 297 × 210 mm (A4)\r\nPapier: BD matt\r\nGrammatur: 170 g/m²\r\nFarben: CMYK / CMYK\r\n\r\nAntwortkarte:\r\nSeiten: 2\r\nFormat: 148 × 95 mm\r\nPapier: LuxoSatin weiß\r\nGrammatur: 250 g/m²\r\nFarben: Schwarz / Schwarz\r\nWeiterverarbeitung: Eckrunden (Anzahl der Ecken: 4 Stück)\r\n\r\nWeiterverarbeitung: Einstecken (Beschreibung: Karte in Flyer, Anzahl einzusteckende Teile: 1 Stück)",
"qty": 1000,
"unit": "piece",
"net_total": 95000,
"created_at": "2019-04-04T13:47:27.333Z",
"updated_at": "2019-04-04T13:47:52.830Z",
"tax_rate": "0.19",
"gross_total": "113050.0",
"billable_id": 105589,
"billable_type": "Product",
"net": "95.0",
"discount": "0.0",
"discounted_net_total": 95000,
"order_number": "PH-4Q-QR",
"environmental_certifications": [],
"accounting_categories": [{
  "name": "Erlöse 19% MwSt.",
  "number": "8400",
  "invoice_kind": "outward",
  "tax_rate": "0.19"
}]
}],
"payment_terms": {
"time_for_payment": 30,
"time_for_first_cashback": 14,
"first_cashback_discount": 0.03,
"time_for_second_cashback": null,
"second_cashback_discount": null
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/customer_invoices get post

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.

Get a list of all CustomerInvoice objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of common.Invoice

Items: CustomerInvoice

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

[
{
  "id": 13569,
  "number": null,
  "net_total": 96411,
  "gross_total": 114729,
  "paid_at": null,
  "created_at": "2018-04-06T11:38:47.211+02:00",
  "updated_at": "2018-04-10T11:20:40.134+02:00",
  "custom_text": null,
  "taxes": {
      "0.19": 18318
  },
  "due_at": null,
  "printery_id": 17,
  "billed_at": null,
  "sent_at": null,
  "business_unit_id": 23,
  "custom_references": {},
  "recipient_type": "Organization",
  "recipient_id": 6710,
  "reversal_invoice_id": null,
  "reversed_invoice_id": null,
  "services_performed_at": "2018-03-26",
  "recipient": {
    "id": 6710,
    "name": "Crispy",
    "tax_identifier": "DE 123456789",
    "email": "crispy@example.com",
    "reference": "Num 12345",
    "debitor_identifier": null,
    "creditor_identifier": null,
    "preferred_locale": null,
    "created_at": "2018-07-03T11:44:52.210+02:00",
    "updated_at": "2018-07-03T11:44:52.210+02:00"
  },
  "contact": {
    "id": 1245,
    "salutation": "Frau",
    "name": "Schöller",
    "first_name": "Maria",
    "mobile": null,
    "phone": null,
    "fax": null,
    "tax_identifier": null,
    "email": "maria@example.com",
    "reference": "HAXEZ3",
    "debitor_identifier": null,
    "preferred_locale": null,
    "created_at": "2017-07-19T13:44:16.332+02:00",
    "updated_at": "2017-08-30T15:40:18.054+02:00"
  },
  "address": {
      "addressee": "Crispy Mountain GmbH",
      "street": "Emmerich Josef Straße",
      "number": "1a",
      "addition": "",
      "zip_code": "55116",
      "town": "Mainz",
      "country_code": "DE"
  },
  "line_items": [
      {
          "id": 19890,
          "invoice_id": 13569,
          "description": "Visitenkarte\nSeiten: 2\nFormat: 85 × 55 mm\nPapier: Kartei  U. Leitkarte Chamois chamois\nGrammatur: 250 g/m²\nFarben: CMYK / CMYK",
          "qty": 500,
          "unit": "piece",
          "net_total": 96411,
          "created_at": "2018-04-06T11:39:04.718+02:00",
          "updated_at": "2018-04-06T11:39:04.718+02:00",
          "tax_rate": "0.19",
          "gross_total": "114729.0",
          "billable_id": 56046,
          "billable_type": "Product",
          "net": "192.821",
          "discount": "0.0",
          "discounted_net_total": 96411,
          "order_number": "EB-9M-BR",
          "accounting_categories": [],
          "environmental_certifications": []
      }
  ]
},
{
  "id": 12994,
  "number": null,
  "net_total": 25010,
  "gross_total": 29762,
  "paid_at": null,
  "created_at": "2018-03-22T11:53:48.570+01:00",
  "updated_at": "2018-03-22T11:54:00.502+01:00",
  "custom_text": null,
  "taxes": {
      "0.19": 4752
  },
  "due_at": null,
  "printery_id": 17,
  "billed_at": null,
  "sent_at": null,
  "business_unit_id": 23,
  "custom_references": {},
  "reversal_invoice_id": null,
  "reversed_invoice_id": null,
  "services_performed_at": null,
  "recipient_type": "Organization",
  "recipient_id": 7250,
  "recipient":   {
      "id": 7250,
      "name": "German Tax Office",
      "tax_identifier": null,
      "email": null,
      "reference": "1069800",
      "debitor_identifier": "10698",
      "creditor_identifier": null,
      "preferred_locale": null,
      "created_at": "2016-12-14T08:05:33.983+01:00",
      "updated_at": "2017-04-27T08:22:22.656+02:00"
    },
  "contact": {
    "id": 1244,
    "salutation": "Frau",
    "name": "König",
    "first_name": "Melanie",
    "mobile": null,
    "phone": "+4912345678",
    "fax": null,
    "tax_identifier": null,
    "email": "melanie@example.com",
    "reference": "A2NK84",
    "debitor_identifier": null,
    "preferred_locale": null,
    "created_at": "2017-11-17T12:25:23.479+01:00",
    "updated_at": "2017-11-17T12:25:23.479+01:00"
  },
  "address": {
      "addressee": "Crispy Mountain GmbH",
      "street": "Emmerich Josef Straße",
      "number": "1a",
      "addition": "",
      "zip_code": "55116",
      "town": "Mainz",
      "country_code": "DE"
  },
  "line_items": [
      {
          "id": 19004,
          "invoice_id": 12994,
          "description": "Visitenkarte\nKarte:\nSeiten: 2\nFormat: 85 × 55 mm\nPapier: Marmor Umschlag Chamois Hellbraun chamois-hellbraun (FSC Mix Credit)\nGrammatur: 200 g/m²\nFarben: CMYK / CMYK\nWeiterverarbeitung: Eckrunden\n\nSchuber:\nSeiten: 4\nGeschlossenes Format: 85 × 55 mm\nOffenes Format: 170 × 55 mm\nPapier: Marmor Umschlag Chamois Hellbraun chamois-hellbraun (FSC Mix Credit)\nGrammatur: 300 g/m²\nFarben: K / K\n\n\nSorten: Müller, Meier",
          "qty": 500,
          "unit": "piece",
          "net_total": 25010,
          "created_at": "2018-03-22T11:54:00.461+01:00",
          "updated_at": "2018-03-22T11:54:00.461+01:00",
          "tax_rate": "0.19",
          "gross_total": "29762.0",
          "billable_id": 45770,
          "billable_type": "Product",
          "net": "50.02",
          "discount": "0.0",
          "discounted_net_total": 25010,
          "order_number": "TQ-7T-MZ",
          "accounting_categories": [],
          "environmental_certifications": [
              "FSC Mix Credit"
          ]
      }
  ]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

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

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Body

Media type: application/json

Type: object

Properties

customer_invoice: required(object)
- number: (string)
- paid_at: (date-only)
- custom_text: (string)
- due_at: (date-only)
- billed_at: (date-only)
- sent_at: (date-only)
- business_unit_id: (integer)
- customer_id: required(integer)
- services_performed_at: (date-only)

Example:

{
"customer_invoice": {
"recipient_id": 57,
"business_unit_id": 23,
"number": "221028",
"custom_text": "Steuerfrei nach § 4 Nr. 1 b i. V. m § 6 a UStG.",
"services_performed_at": "2018-04-08"
}
}

HTTP status code 201

This response is returned if creating a new CustomerInvoice was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

{
"id": 13569,
"number": null,
"net_total": 96411,
"gross_total": 114729,
"paid_at": null,
"created_at": "2018-04-06T11:38:47.211+02:00",
"updated_at": "2018-04-10T11:20:40.134+02:00",
"custom_text": null,
"taxes": {
    "0.19": 18318
},
"due_at": null,
"printery_id": 17,
"billed_at": null,
"sent_at": null,
"business_unit_id": 23,
"custom_references": {},
"reversal_invoice_id": null,
"reversed_invoice_id": null,
"services_performed_at": "2018-03-26",
"recipient_type": "Organization",
"recipient_id": 6710,
"recipient": {
  "id": 6710,
  "name": "Crispy",
  "tax_identifier": "DE 123456789",
  "email": "crispy@example.com",
  "reference": "Num 12345",
  "debitor_identifier": null,
  "creditor_identifier": null,
  "preferred_locale": null,
  "created_at": "2018-07-03T11:44:52.210+02:00",
  "updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
  "id": 1245,
  "salutation": "Frau",
  "name": "Schöller",
  "first_name": "Maria",
  "mobile": null,
  "phone": null,
  "fax": null,
  "tax_identifier": null,
  "email": "maria@example.com",
  "reference": "HAXEZ3",
  "debitor_identifier": null,
  "preferred_locale": null,
  "created_at": "2017-07-19T13:44:16.332+02:00",
  "updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich Josef Straße",
    "number": "1a",
    "addition": "",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
},
"line_items": [
    {
        "id": 19890,
        "invoice_id": 13569,
        "description": "Visitenkarte\nSeiten: 2\nFormat: 85 × 55 mm\nPapier: Kartei  U. Leitkarte Chamois chamois\nGrammatur: 250 g/m²\nFarben: CMYK / CMYK",
        "qty": 500,
        "unit": "piece",
        "net_total": 96411,
        "created_at": "2018-04-06T11:39:04.718+02:00",
        "updated_at": "2018-04-06T11:39:04.718+02:00",
        "tax_rate": "0.19",
        "gross_total": "114729.0",
        "billable_id": 56046,
        "billable_type": "Product",
        "net": "192.821",
        "discount": "0.0",
        "discounted_net_total": 96411,
        "order_number": "EB-9M-BR",
        "accounting_categories": [],
        "environmental_certifications": []
    }
]
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/customer_invoices/{customer_invoice_id} get patch delete

The collection of CustomerInvoices.

get

Get a single CustomerInvoice record.

patch

Update details for a draft customer invoice.

delete

Delete a draft customer invoice.

Get a single CustomerInvoice record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

{
"id": 13569,
"number": null,
"net_total": 96411,
"gross_total": 114729,
"paid_at": null,
"created_at": "2018-04-06T11:38:47.211+02:00",
"updated_at": "2018-04-10T11:20:40.134+02:00",
"custom_text": null,
"taxes": {
    "0.19": 18318
},
"due_at": null,
"printery_id": 17,
"billed_at": null,
"sent_at": null,
"business_unit_id": 23,
"custom_references": {},
"reversal_invoice_id": null,
"reversed_invoice_id": null,
"services_performed_at": "2018-03-26",
"recipient_type": "Organization",
"recipient_id": 6710,
"recipient": {
  "id": 6710,
  "name": "Crispy",
  "tax_identifier": "DE 123456789",
  "email": "crispy@example.com",
  "reference": "Num 12345",
  "debitor_identifier": null,
  "creditor_identifier": null,
  "preferred_locale": null,
  "created_at": "2018-07-03T11:44:52.210+02:00",
  "updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
  "id": 1245,
  "salutation": "Frau",
  "name": "Schöller",
  "first_name": "Maria",
  "mobile": null,
  "phone": null,
  "fax": null,
  "tax_identifier": null,
  "email": "maria@example.com",
  "reference": "HAXEZ3",
  "debitor_identifier": null,
  "preferred_locale": null,
  "created_at": "2017-07-19T13:44:16.332+02:00",
  "updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich Josef Straße",
    "number": "1a",
    "addition": "",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
},
"line_items": [
    {
        "id": 19890,
        "invoice_id": 13569,
        "description": "Visitenkarte\nSeiten: 2\nFormat: 85 × 55 mm\nPapier: Kartei  U. Leitkarte Chamois chamois\nGrammatur: 250 g/m²\nFarben: CMYK / CMYK",
        "qty": 500,
        "unit": "piece",
        "net_total": 96411,
        "created_at": "2018-04-06T11:39:04.718+02:00",
        "updated_at": "2018-04-06T11:39:04.718+02:00",
        "tax_rate": "0.19",
        "gross_total": "114729.0",
        "billable_id": 56046,
        "billable_type": "Product",
        "net": "192.821",
        "discount": "0.0",
        "discounted_net_total": 96411,
        "order_number": "EB-9M-BR",
        "accounting_categories": [],
        "environmental_certifications": []
    }
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for a draft customer invoice.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

Body

Media type: application/json

Type: object

Properties

customer_invoice: required(object)
- number: (string)
- paid_at: (date-only)
- custom_text: (string)
- due_at: (date-only)
- billed_at: (date-only)
- sent_at: (date-only)
- business_unit_id: (integer)
- customer_id: required(integer)
- services_performed_at: (date-only)

Example:

{
"customer_invoice": {
"recipient_id": 57,
"business_unit_id": 23,
"number": "221028",
"custom_text": "Steuerfrei nach § 4 Nr. 1 b i. V. m § 6 a UStG.",
"services_performed_at": "2018-04-08"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete a draft customer invoice.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/customer_invoices/{customer_invoice_id}/contact post patch

The Contact record associated with the parent record.

post

Create a new Contact record.

patch

Update details for a contact.

Create a new Contact record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

Body

Media type: application/json

Type: ContactRequest

HTTP status code 201

This response is returned if creating a new Contact was successful.

Body

Media type: application/json

Type: Contact

Example:

Can not resolve examples/api-v2/configuration/contacts/get_id_200_response.json

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for a contact.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

Body

Media type: application/json

Type: ContactRequest

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/customer_invoices/{customer_invoice_id}/address post patch

The Address record associated with the parent record.

post

Create a new Address record.

patch

Update details for an address.

Create a new Address record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

Body

Media type: application/json

Type: object

Properties

address: required(object)
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information

Example:

{
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Straße",
    "number": "1a",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
}
}

HTTP status code 201

This response is returned if creating a new Address was successful.

Body

Media type: application/json

Type: object

Properties

addressee: required(string)
town: required(string)
number: (string)
country_code: required(string)
ISO Country code of country this address is located in.
zip_code: required(string)
street: (string)
addition: (string)
An optional additional information, usually displayed right below the address.

Example:

{
"id": 195900,
"addressee": "Crispy Mountain GmbH",
"street": "Emmerich-Josef-Straße",
"number": "1a",
"addition": null,
"zip_code": "55116",
"town": "Mainz",
"country_code": "DE",
"fingerprint": "0bd0c67b086f05346dac284e606c4d30",
"created_at": "2019-06-27T13:25:52.423Z",
"updated_at": "2019-07-01T11:04:16.228Z"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for an address.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

Body

Media type: application/json

Type: object

Properties

address: required(object)
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information

Example:

{
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Straße",
    "number": "1a",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/customer_invoices/{customer_invoice_id}/line_items get post

The collection of LineItems

get

Get a list of all LineItem objects.

post

Create a new LineItem object.

Get a list of all LineItem objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: LineItem

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
description: required(string)
qty: required(integer - minimum: 1)
unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
net_total: required(integer)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
tax_rate: required(number - minimum: 0 - maximum: 1)
gross_total: required(number)
billable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billable_type: required(string)
net: required(number)
For credit notes net, must be less than or equal to 0
discount: required(number)
discounted_net_total: required(integer)
order_number: required(string)
accounting_category_ids: required(array of any)
environmental_certifications: required(string)

Example:

[
{
  "id": 17874,
  "invoice_id": 12268,
  "description": "Visitenkarte\nKarte:\nSeiten: 2\nFormat: 85 × 55 mm\nPapier: Marmor Umschlag Chamois Hellbraun chamois-hellbraun (FSC Mix Credit)\nGrammatur: 200 g/m²\nFarben: CMYK / CMYK\nWeiterverarbeitung: Eckrunden\n\nSchuber:\nSeiten: 4\nGeschlossenes Format: 85 × 55 mm\nOffenes Format: 170 × 55 mm\nPapier: Kartei  U. Leitkarte Chamois chamois\nGrammatur: 250 g/m²\nFarben: K / K\n\n\nSorten: Meier, Müller",
  "qty": 1000,
  "unit": "piece",
  "net_total": 33333,
  "created_at": "2018-03-06T12:13:54.033+01:00",
  "updated_at": "2018-03-06T12:13:54.033+01:00",
  "tax_rate": "0.19",
  "gross_total": "39666.0",
  "billable_id": 53991,
  "billable_type": "Product",
  "net": "33.33333333333334",
  "discount": "0.0",
  "discounted_net_total": 33333,
  "order_number": "4W-2K-CS",
  "accounting_categories": [],
  "environmental_certifications": [
      "FSC Mix Credit"
  ]
},
{
  "id": 17875,
  "invoice_id": 12268,
  "description": "Freistellen",
  "qty": 1,
  "unit": "hours",
  "net_total": 6000,
  "created_at": "2018-03-06T12:13:54.079+01:00",
  "updated_at": "2018-03-06T12:13:54.079+01:00",
  "tax_rate": "0.19",
  "gross_total": "7140.0",
  "billable_id": 326,
  "billable_type": "Service",
  "net": "6000.0",
  "discount": "0.0",
  "discounted_net_total": 6000,
  "order_number": null,
  "accounting_categories": [],
  "environmental_certifications": []
},
{
  "id": 17876,
  "invoice_id": 12268,
  "description": "Versand",
  "qty": 1,
  "unit": null,
  "net_total": 450,
  "created_at": "2018-03-06T12:13:54.124+01:00",
  "updated_at": "2018-03-06T12:13:54.124+01:00",
  "tax_rate": "0.19",
  "gross_total": "536.0",
  "billable_id": null,
  "billable_type": null,
  "net": "450.0",
  "discount": "0.0",
  "discounted_net_total": 450,
  "order_number": null,
  "accounting_categories": [],
  "environmental_certifications": []
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new LineItem object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

Body

Media type: application/json

Type: object

Properties

line_item: required(object)
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream, minutes, hours)
- tax_rate: required(number - minimum: 0 - maximum: 1)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: (number)
- order_number: (string)
- accounting_category_id: (array of any)

Example:

{
"line_item": {
"description": "Freistellen",
"qty": 1,
"unit": "hours",
"tax_rate": 0.19,
"net": 6000.0,
"discount": 0.0,
"order_number": "XE-G4-D2"
}
}

HTTP status code 201

This response is returned if creating a new LineItem was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
description: required(string)
qty: required(integer - minimum: 1)
unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
net_total: required(integer)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
tax_rate: required(number - minimum: 0 - maximum: 1)
gross_total: required(number)
billable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billable_type: required(string)
net: required(number)
For credit notes net, must be less than or equal to 0
discount: required(number)
discounted_net_total: required(integer)
order_number: required(string)
accounting_category_ids: required(array of any)
environmental_certifications: required(string)

Example:

{
"id": 17875,
"invoice_id": 12268,
"description": "Freistellen",
"qty": 1,
"unit": "hours",
"net_total": 6000,
"created_at": "2018-03-06T12:13:54.079+01:00",
"updated_at": "2018-03-06T12:13:54.079+01:00",
"tax_rate": "0.19",
"gross_total": "7140.0",
"billable_id": 326,
"billable_type": "Service",
"net": "6000.0",
"discount": "0.0",
"discounted_net_total": 6000,
"order_number": null,
"accounting_categories": [],
"environmental_certifications": []
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/customer_invoices/{customer_invoice_id}/line_items/{line_item_id} get patch delete

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.

Get a single LineItem record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)
line_item_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
description: required(string)
qty: required(integer - minimum: 1)
unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
net_total: required(integer)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
tax_rate: required(number - minimum: 0 - maximum: 1)
gross_total: required(number)
billable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billable_type: required(string)
net: required(number)
For credit notes net, must be less than or equal to 0
discount: required(number)
discounted_net_total: required(integer)
order_number: required(string)
accounting_category_ids: required(array of any)
environmental_certifications: required(string)

Example:

{
"id": 17875,
"invoice_id": 12268,
"description": "Freistellen",
"qty": 1,
"unit": "hours",
"net_total": 6000,
"created_at": "2018-03-06T12:13:54.079+01:00",
"updated_at": "2018-03-06T12:13:54.079+01:00",
"tax_rate": "0.19",
"gross_total": "7140.0",
"billable_id": 326,
"billable_type": "Service",
"net": "6000.0",
"discount": "0.0",
"discounted_net_total": 6000,
"order_number": null,
"accounting_categories": [],
"environmental_certifications": []
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for a line item.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)
line_item_id: required(string)

Body

Media type: application/json

Type: object

Properties

line_item: required(object)
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream, minutes, hours)
- tax_rate: required(number - minimum: 0 - maximum: 1)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: (number)
- order_number: (string)
- accounting_category_id: (array of any)

Example:

{
"line_item": {
"description": "Freistellen",
"qty": 1,
"unit": "hours",
"tax_rate": 0.19,
"net": 6000.0,
"discount": 0.0,
"order_number": "XE-G4-D2"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete a line item for draft customer invoice.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)
line_item_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/customer_invoices/{customer_invoice_id}/payment_terms post patch

The PaymentTerms record associated with the parent record.

post

Create a new PaymentTerm record.

patch

Update details for payment terms.

Create a new PaymentTerm record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

Body

Media type: application/json

Type: object

Properties

payment_terms: required(object)
- time_for_payment: required(integer - minimum: 0)
- accepted_means_of_payment: (string)
- time_for_first_cashback: (integer - minimum: 1)
- first_cashback_discount: (number - minimum: 0.1 - maximum: 1)
- time_for_second_cashback: (integer - minimum: 1)
- second_cashback_discount: (number - minimum: 0.1 - maximum: 1)

Example:

{
"payment_terms": {
"time_for_payment": 7,
"time_for_first_cashback": 3,
"first_cashback_discount": 0.1
}
}

HTTP status code 201

This response is returned if creating a new PaymentTerm was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
payment_termable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
payment_termable_type: required(string)
time_for_payment: required(integer - minimum: 0)
accepted_means_of_payment: required(string)
time_for_first_cashback: required(integer - minimum: 1)
first_cashback_discount: required(number - minimum: 0.1 - maximum: 1)
time_for_second_cashback: required(integer - minimum: 1)
second_cashback_discount: required(number - minimum: 0.1 - maximum: 1)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 16492,
"payment_termable_id": 13661,
"payment_termable_type": "Invoice",
"time_for_payment": 7,
"accepted_means_of_payment": null,
"time_for_first_cashback": 3,
"first_cashback_discount": 0.1,
"time_for_second_cashback": null,
"second_cashback_discount": null,
"created_at": "2018-04-10T14:59:40.970+02:00",
"updated_at": "2018-04-10T14:59:40.970+02:00"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for payment terms.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

Body

Media type: application/json

Type: object

Properties

payment_terms: required(object)
- time_for_payment: required(integer - minimum: 0)
- accepted_means_of_payment: (string)
- time_for_first_cashback: (integer - minimum: 1)
- first_cashback_discount: (number - minimum: 0.1 - maximum: 1)
- time_for_second_cashback: (integer - minimum: 1)
- second_cashback_discount: (number - minimum: 0.1 - maximum: 1)

Example:

{
"payment_terms": {
"time_for_payment": 7,
"time_for_first_cashback": 3,
"first_cashback_discount": 0.1
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/customer_invoices/{customer_invoice_id}/reversal_invoice post

The ReversalInvoice record associated with the parent record.

post

Cancel a billed customer invoice and create a reversal invoice.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

customer_invoice_id: required(string)

HTTP status code 201

This response is returned if creating a new ReversalInvoice was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

{
"id": 13668,
"number": "180411002",
"net_total": -96411,
"gross_total": -114729,
"paid_at": null,
"created_at": "2018-04-11T10:27:54.298+02:00",
"updated_at": "2018-04-11T10:27:54.356+02:00",
"custom_text": null,
"taxes": {
  "0.19": -18318
},
"due_at": "2018-04-11",
"printery_id": 17,
"billed_at": "2018-04-11",
"sent_at": null,
"business_unit_id": 23,
"custom_references": {},
"reversal_invoice_id": null,
"reversed_invoice_id": 13569,
"services_performed_at": "2018-03-26",
"recipient_type": "Organization",
"recipient_id": 6710,
"recipient": {
"id": 6710,
"name": "Crispy",
"tax_identifier": "DE 123456789",
"email": "crispy@example.com",
"reference": "Num 12345",
"debitor_identifier": null,
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2018-07-03T11:44:52.210+02:00",
"updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
"id": 1245,
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-07-19T13:44:16.332+02:00",
"updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
  "addressee": "Crispy Mountain GmbH",
  "street": "Emmerich Josef Straße",
  "number": "1a",
  "addition": "",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"line_items": [
  {
      "id": 19999,
      "invoice_id": 13668,
      "description": "Visitenkarte\nSeiten: 2\nFormat: 85 × 55 mm\nPapier: Kartei  U. Leitkarte Chamois chamois\nGrammatur: 250 g/m²\nFarben: CMYK / CMYK",
      "qty": 500,
      "unit": "piece",
      "net_total": -96411,
      "created_at": "2018-04-11T10:27:54.318+02:00",
      "updated_at": "2018-04-11T10:27:54.318+02:00",
      "tax_rate": "0.19",
      "gross_total": "-114729.0",
      "billable_id": 56046,
      "billable_type": "Product",
      "net": "-192.821",
      "discount": "0.0",
      "discounted_net_total": -96411,
      "order_number": "EB-9M-BR",
      "accounting_categories": [],
      "environmental_certifications": []
  }
]
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/credit_notes get post

The collection of CreditNotes

get

Get a list of all CreditNote objects.

post

Create a new CreditNote object.

Get a list of all CreditNote objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of common.Invoice

Items: CreditNote

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

[
{
  "id": 13664,
  "number": "180410002",
  "net_total": -6000,
  "gross_total": -7140,
  "paid_at": null,
  "created_at": "2018-04-10T13:28:22.932+02:00",
  "updated_at": "2018-04-10T13:28:59.972+02:00",
  "custom_text": null,
  "taxes": {
      "0.19": -1140
  },
  "due_at": null,
  "printery_id": 17,
  "billed_at": "2018-04-10",
  "sent_at": null,
  "business_unit_id": 23,
  "custom_references": {},
  "reversal_invoice_id": null,
  "reversed_invoice_id": null,
  "services_performed_at": "2018-03-06",
  "recipient_type": "Organization",
  "recipient_id": 6710,
  "recipient": {
    "id": 6710,
    "name": "Crispy",
    "tax_identifier": "DE 123456789",
    "email": "crispy@example.com",
    "reference": "Num 12345",
    "debitor_identifier": null,
    "creditor_identifier": null,
    "preferred_locale": null,
    "created_at": "2018-07-03T11:44:52.210+02:00",
    "updated_at": "2018-07-03T11:44:52.210+02:00"
  },
  "contact": {
    "id": 1245,
    "salutation": "Frau",
    "name": "Schöller",
    "first_name": "Maria",
    "mobile": null,
    "phone": null,
    "fax": null,
    "tax_identifier": null,
    "email": "maria@example.com",
    "reference": "HAXEZ3",
    "debitor_identifier": null,
    "preferred_locale": null,
    "created_at": "2017-07-19T13:44:16.332+02:00",
    "updated_at": "2017-08-30T15:40:18.054+02:00"
  },
  "address": {
      "addressee": "Crispy Mountain GmbH",
      "street": "Emmerich Josef Straße",
      "number": "1a",
      "addition": "",
      "zip_code": "55116",
      "town": "Mainz",
      "country_code": "DE"
  },
  "line_items": [
      {
          "id": 19997,
          "invoice_id": 13664,
          "description": "Provision für Produkt CR-SS-Q2",
          "qty": 1,
          "unit": "piece",
          "net_total": -6000,
          "created_at": "2018-04-10T13:28:50.813+02:00",
          "updated_at": "2018-04-10T13:28:50.813+02:00",
          "tax_rate": "0.19",
          "gross_total": "-7140.0",
          "billable_id": null,
          "billable_type": null,
          "net": "-6000.0",
          "discount": "0.0",
          "discounted_net_total": -6000,
          "order_number": null,
          "accounting_categories": [],
          "environmental_certifications": []
      }
  ]
},
{
  "id": 13663,
  "number": "180410001",
  "net_total": -12000,
  "gross_total": -14280,
  "paid_at": null,
  "created_at": "2018-04-10T13:26:46.965+02:00",
  "updated_at": "2018-04-10T13:28:11.627+02:00",
  "custom_text": null,
  "taxes": {
      "0.19": -2280
  },
  "due_at": null,
  "printery_id": 17,
  "billed_at": "2018-04-10",
  "sent_at": null,
  "business_unit_id": 23,
  "custom_references": {},
  "reversal_invoice_id": null,
  "reversed_invoice_id": null,
  "services_performed_at": "2018-04-09",
  "recipient_type": "Organization",
  "recipient_id": 6710,
  "recipient": {
    "id": 6710,
    "name": "Crispy",
    "tax_identifier": "DE 123456789",
    "email": "crispy@example.com",
    "reference": "Num 12345",
    "debitor_identifier": null,
    "creditor_identifier": null,
    "preferred_locale": null,
    "created_at": "2018-07-03T11:44:52.210+02:00",
    "updated_at": "2018-07-03T11:44:52.210+02:00"
  },
  "contact": {
    "id": 1245,
    "salutation": "Frau",
    "name": "Schöller",
    "first_name": "Maria",
    "mobile": null,
    "phone": null,
    "fax": null,
    "tax_identifier": null,
    "email": "maria@example.com",
    "reference": "HAXEZ3",
    "debitor_identifier": null,
    "preferred_locale": null,
    "created_at": "2017-07-19T13:44:16.332+02:00",
    "updated_at": "2017-08-30T15:40:18.054+02:00"
  },
  "address": {
      "addressee": "Crispy Mountain GmbH",
      "street": "Emmerich Josef Straße",
      "number": "1a",
      "addition": "",
      "zip_code": "55116",
      "town": "Mainz",
      "country_code": "DE"
  },
  "line_items": [
      {
          "id": 19996,
          "invoice_id": 13663,
          "description": "Provision",
          "qty": 1,
          "unit": null,
          "net_total": -12000,
          "created_at": "2018-04-10T13:28:01.035+02:00",
          "updated_at": "2018-04-10T13:28:01.035+02:00",
          "tax_rate": "0.19",
          "gross_total": "-14280.0",
          "billable_id": null,
          "billable_type": null,
          "net": "-12000.0",
          "discount": "0.0",
          "discounted_net_total": -12000,
          "order_number": null,
          "accounting_categories": [],
          "environmental_certifications": []
      }
  ]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new CreditNote object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Body

Media type: application/json

Type: object

Properties

credit_note: required(object)
- number: (string)
- paid_at: (date-only)
- custom_text: (string)
- due_at: (date-only)
- billed_at: (date-only)
- sent_at: (date-only)
- business_unit_id: (integer)
- affiliate_id: required(integer)
- services_performed_at: (date-only)

Example:

{
"credit_note": {
"recipient_id": 57,
"business_unit_id": 23,
"number": "221028",
"services_performed_at": "2018-04-08"
}
}

HTTP status code 201

This response is returned if creating a new CreditNote was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

{
"id": 13664,
"number": "180410002",
"net_total": -6000,
"gross_total": -7140,
"paid_at": null,
"created_at": "2018-04-10T13:28:22.932+02:00",
"updated_at": "2018-04-10T13:28:59.972+02:00",
"custom_text": null,
"taxes": {
  "0.19": -1140
},
"due_at": null,
"printery_id": 17,
"billed_at": "2018-04-10",
"sent_at": null,
"business_unit_id": 23,
"custom_references": {},
"reversal_invoice_id": null,
"reversed_invoice_id": null,
"services_performed_at": "2018-03-06",
"recipient_id": 6710,
"recipient": {
"id": 6710,
"name": "Crispy",
"tax_identifier": "DE 123456789",
"email": "crispy@example.com",
"reference": "Num 12345",
"debitor_identifier": null,
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2018-07-03T11:44:52.210+02:00",
"updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
"id": 1245,
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-07-19T13:44:16.332+02:00",
"updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
  "addressee": "Crispy Mountain GmbH",
  "street": "Emmerich Josef Straße",
  "number": "1a",
  "addition": "",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"line_items": [
  {
      "id": 19997,
      "invoice_id": 13664,
      "description": "Provision für Produkt CR-SS-Q2",
      "qty": 1,
      "unit": "piece",
      "net_total": -6000,
      "created_at": "2018-04-10T13:28:50.813+02:00",
      "updated_at": "2018-04-10T13:28:50.813+02:00",
      "tax_rate": "0.19",
      "gross_total": "-7140.0",
      "billable_id": null,
      "billable_type": null,
      "net": "-6000.0",
      "discount": "0.0",
      "discounted_net_total": -6000,
      "order_number": null,
      "accounting_categories": [],
      "environmental_certifications": []
  }
]
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/credit_notes/{credit_note_id} get patch delete

The collection of CreditNotes.

get

Get a single CreditNote record.

patch

Update details for a draft credit note.

delete

Delete a draft credit note.

Get a single CreditNote record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

{
"id": 13664,
"number": "180410002",
"net_total": -6000,
"gross_total": -7140,
"paid_at": null,
"created_at": "2018-04-10T13:28:22.932+02:00",
"updated_at": "2018-04-10T13:28:59.972+02:00",
"custom_text": null,
"taxes": {
  "0.19": -1140
},
"due_at": null,
"printery_id": 17,
"billed_at": "2018-04-10",
"sent_at": null,
"business_unit_id": 23,
"custom_references": {},
"reversal_invoice_id": null,
"reversed_invoice_id": null,
"services_performed_at": "2018-03-06",
"recipient_id": 6710,
"recipient": {
"id": 6710,
"name": "Crispy",
"tax_identifier": "DE 123456789",
"email": "crispy@example.com",
"reference": "Num 12345",
"debitor_identifier": null,
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2018-07-03T11:44:52.210+02:00",
"updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
"id": 1245,
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-07-19T13:44:16.332+02:00",
"updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
  "addressee": "Crispy Mountain GmbH",
  "street": "Emmerich Josef Straße",
  "number": "1a",
  "addition": "",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"line_items": [
  {
      "id": 19997,
      "invoice_id": 13664,
      "description": "Provision für Produkt CR-SS-Q2",
      "qty": 1,
      "unit": "piece",
      "net_total": -6000,
      "created_at": "2018-04-10T13:28:50.813+02:00",
      "updated_at": "2018-04-10T13:28:50.813+02:00",
      "tax_rate": "0.19",
      "gross_total": "-7140.0",
      "billable_id": null,
      "billable_type": null,
      "net": "-6000.0",
      "discount": "0.0",
      "discounted_net_total": -6000,
      "order_number": null,
      "accounting_categories": [],
      "environmental_certifications": []
  }
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for a draft credit note.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

Body

Media type: application/json

Type: object

Properties

credit_note: required(object)
- number: (string)
- paid_at: (date-only)
- custom_text: (string)
- due_at: (date-only)
- billed_at: (date-only)
- sent_at: (date-only)
- business_unit_id: (integer)
- affiliate_id: required(integer)
- services_performed_at: (date-only)

Example:

{
"credit_note": {
"recipient_id": 57,
"business_unit_id": 23,
"number": "221028",
"services_performed_at": "2018-04-08"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete a draft credit note.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/credit_notes/{credit_note_id}/contact post patch

The Contact record associated with the parent record.

post

Create a new Contact record.

patch

Update details for a contact.

Create a new Contact record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

Body

Media type: application/json

Type: ContactRequest

HTTP status code 201

This response is returned if creating a new Contact was successful.

Body

Media type: application/json

Type: Contact

Example:

Can not resolve examples/api-v2/configuration/contacts/get_id_200_response.json

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for a contact.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

Body

Media type: application/json

Type: ContactRequest

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/credit_notes/{credit_note_id}/address post patch

The Address record associated with the parent record.

post

Create a new Address record.

patch

Update details for an address.

Create a new Address record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

Body

Media type: application/json

Type: object

Properties

address: required(object)
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information

Example:

{
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Straße",
    "number": "1a",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
}
}

HTTP status code 201

This response is returned if creating a new Address was successful.

Body

Media type: application/json

Type: object

Properties

addressee: required(string)
town: required(string)
number: (string)
country_code: required(string)
ISO Country code of country this address is located in.
zip_code: required(string)
street: (string)
addition: (string)
An optional additional information, usually displayed right below the address.

Example:

Can not resolve examples/api-v2/configuration/addresses//get_id_200_response.json

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for an address.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

Body

Media type: application/json

Type: object

Properties

address: required(object)
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information

Example:

{
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Straße",
    "number": "1a",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/credit_notes/{credit_note_id}/line_items get post

The collection of LineItems

get

Get a list of all LineItem objects.

post

Create a new LineItem object.

Get a list of all LineItem objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: LineItem

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
description: required(string)
qty: required(integer - minimum: 1)
unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
net_total: required(integer)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
tax_rate: required(number - minimum: 0 - maximum: 1)
gross_total: required(number)
billable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billable_type: required(string)
net: required(number)
For credit notes net, must be less than or equal to 0
discount: required(number)
discounted_net_total: required(integer)
order_number: required(string)
accounting_category_ids: required(array of any)
environmental_certifications: required(string)

Example:

[
{
  "id": 19997,
  "invoice_id": 13664,
  "description": "Provision für Produkt CR-SS-Q2",
  "qty": 1,
  "unit": "piece",
  "net_total": -6000,
  "created_at": "2018-04-10T13:28:50.813+02:00",
  "updated_at": "2018-04-10T13:28:50.813+02:00",
  "tax_rate": "0.19",
  "gross_total": "-7140.0",
  "billable_id": null,
  "billable_type": null,
  "net": "-6000.0",
  "discount": "0.0",
  "discounted_net_total": -6000,
  "order_number": null,
  "accounting_categories": [],
  "environmental_certifications": []
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new LineItem object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)

Body

Media type: application/json

Type: object

Properties

line_item: required(object)
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream, minutes, hours)
- tax_rate: required(number - minimum: 0 - maximum: 1)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: (number)
- order_number: (string)
- accounting_category_id: (array of any)

Example:

{
"line_item": {
"description": "Provision für Produkt CR-SS-Q2",
"qty": 1,
"unit": "piece",
"tax_rate": 0.19,
"net": "-6000.0",
"discount": 0.0,
}
}

HTTP status code 201

This response is returned if creating a new LineItem was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
description: required(string)
qty: required(integer - minimum: 1)
unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
net_total: required(integer)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
tax_rate: required(number - minimum: 0 - maximum: 1)
gross_total: required(number)
billable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billable_type: required(string)
net: required(number)
For credit notes net, must be less than or equal to 0
discount: required(number)
discounted_net_total: required(integer)
order_number: required(string)
accounting_category_ids: required(array of any)
environmental_certifications: required(string)

Example:

{
"id": 19997,
"invoice_id": 13664,
"description": "Provision für Produkt CR-SS-Q2",
"qty": 1,
"unit": "piece",
"net_total": -6000,
"created_at": "2018-04-10T13:28:50.813+02:00",
"updated_at": "2018-04-10T13:28:50.813+02:00",
"tax_rate": "0.19",
"gross_total": "-7140.0",
"billable_id": null,
"billable_type": null,
"net": "-6000.0",
"discount": "0.0",
"discounted_net_total": -6000,
"order_number": null,
"accounting_categories": [],
"environmental_certifications": []
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/credit_notes/{credit_note_id}/line_items/{line_item_id} get patch delete

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.

Get a single LineItem record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)
line_item_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
description: required(string)
qty: required(integer - minimum: 1)
unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
net_total: required(integer)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
tax_rate: required(number - minimum: 0 - maximum: 1)
gross_total: required(number)
billable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billable_type: required(string)
net: required(number)
For credit notes net, must be less than or equal to 0
discount: required(number)
discounted_net_total: required(integer)
order_number: required(string)
accounting_category_ids: required(array of any)
environmental_certifications: required(string)

Example:

{
"id": 19997,
"invoice_id": 13664,
"description": "Provision für Produkt CR-SS-Q2",
"qty": 1,
"unit": "piece",
"net_total": -6000,
"created_at": "2018-04-10T13:28:50.813+02:00",
"updated_at": "2018-04-10T13:28:50.813+02:00",
"tax_rate": "0.19",
"gross_total": "-7140.0",
"billable_id": null,
"billable_type": null,
"net": "-6000.0",
"discount": "0.0",
"discounted_net_total": -6000,
"order_number": null,
"accounting_categories": [],
"environmental_certifications": []
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for a line item.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)
line_item_id: required(string)

Body

Media type: application/json

Type: object

Properties

line_item: required(object)
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream, minutes, hours)
- tax_rate: required(number - minimum: 0 - maximum: 1)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: (number)
- order_number: (string)
- accounting_category_id: (array of any)

Example:

{
"line_item": {
"description": "Provision für Produkt CR-SS-Q2",
"qty": 1,
"unit": "piece",
"tax_rate": 0.19,
"net": "-6000.0",
"discount": 0.0,
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete a line item for draft credit note.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

credit_note_id: required(string)
line_item_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/reversal_invoices get

The collection of ReversalInvoices

get

Get a list of all ReversalInvoice objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of common.Invoice

Items: ReversalInvoice

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

[
{
"id": 13668,
"number": "180411002",
"net_total": -96411,
"gross_total": -114729,
"paid_at": null,
"created_at": "2018-04-11T10:27:54.298+02:00",
"updated_at": "2018-04-11T10:27:54.356+02:00",
"custom_text": null,
"taxes": {
    "0.19": -18318
},
"due_at": "2018-04-11",
"printery_id": 17,
"billed_at": "2018-04-11",
"sent_at": null,
"business_unit_id": 23,
"custom_references": {},
"reversal_invoice_id": null,
"reversed_invoice_id": 13569,
"services_performed_at": "2018-03-26",
"recipient_type": "Organization",
"recipient_id": 6710,
"recipient": {
  "id": 6710,
  "name": "Crispy",
  "tax_identifier": "DE 123456789",
  "email": "crispy@example.com",
  "reference": "Num 12345",
  "debitor_identifier": null,
  "creditor_identifier": null,
  "preferred_locale": null,
  "created_at": "2018-07-03T11:44:52.210+02:00",
  "updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
  "id": 1245,
  "salutation": "Frau",
  "name": "Schöller",
  "first_name": "Maria",
  "mobile": null,
  "phone": null,
  "fax": null,
  "tax_identifier": null,
  "email": "maria@example.com",
  "reference": "HAXEZ3",
  "debitor_identifier": null,
  "preferred_locale": null,
  "created_at": "2017-07-19T13:44:16.332+02:00",
  "updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich Josef Straße",
    "number": "1a",
    "addition": "",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
},
"line_items": [
    {
        "id": 19999,
        "invoice_id": 13668,
        "description": "Visitenkarte\nSeiten: 2\nFormat: 85 × 55 mm\nPapier: Kartei  U. Leitkarte Chamois chamois\nGrammatur: 250 g/m²\nFarben: CMYK / CMYK",
        "qty": 500,
        "unit": "piece",
        "net_total": -96411,
        "created_at": "2018-04-11T10:27:54.318+02:00",
        "updated_at": "2018-04-11T10:27:54.318+02:00",
        "tax_rate": "0.19",
        "gross_total": "-114729.0",
        "billable_id": 56046,
        "billable_type": "Product",
        "net": "-192.821",
        "discount": "0.0",
        "discounted_net_total": -96411,
        "order_number": "EB-9M-BR",
        "accounting_categories": [],
        "environmental_certifications": []
    }
]
},
{
"id": 912,
"number": "27",
"net_total": -241014,
"gross_total": -286807,
"paid_at": null,
"created_at": "2016-11-30T14:31:58.341+01:00",
"updated_at": "2016-11-30T14:31:58.728+01:00",
"custom_text": null,
"taxes": {
    "0.19": -45793
},
"due_at": "2016-11-30",
"printery_id": 17,
"billed_at": "2016-11-30",
"sent_at": null,
"business_unit_id": 23,
"custom_references": {},
"reversal_invoice_id": null,
"reversed_invoice_id": 911,
"services_performed_at": "2016-11-30",
"recipient_type": "Organization",
"recipient_id": 7250,
"recipient":   {
    "id": 7250,
    "name": "German Tax Office",
    "tax_identifier": null,
    "email": null,
    "reference": "1069800",
    "debitor_identifier": "10698",
    "creditor_identifier": null,
    "preferred_locale": null,
    "created_at": "2016-12-14T08:05:33.983+01:00",
    "updated_at": "2017-04-27T08:22:22.656+02:00"
  },
"contact": {
  "id": 1244,
  "salutation": "Frau",
  "name": "König",
  "first_name": "Melanie",
  "mobile": null,
  "phone": "+4912345678",
  "fax": null,
  "tax_identifier": null,
  "email": "melanie@example.com",
  "reference": "A2NK84",
  "debitor_identifier": null,
  "preferred_locale": null,
  "created_at": "2017-11-17T12:25:23.479+01:00",
  "updated_at": "2017-11-17T12:25:23.479+01:00"
},
"address": {
    "addressee": "Autohaus Müller GmbH",
    "street": "Musterstraße",
    "number": "123",
    "addition": "",
    "zip_code": "12345",
    "town": "Musterstadt",
    "country_code": "DE"
},
"line_items": [
    {
        "id": 994,
        "invoice_id": 912,
        "description": "Broschüre (Rückendrahtheftung)\nUmschlag:\n\tSeiten: 4\n\tGeschlossenes Format: A4\n\tOffenes Format: 420 mm × 297 mm (A3)\n\tPapier: Multiart Silk Weiß\n\tGrammatur: 250 g/m²\n\tFarben: CMYK / CMYK\n\tWeiterverarbeitung: Rillen, Dispersionslackieren\n\nInnenteil:\n\tSeiten: 32\n\tGeschlossenes Format: A4\n\tOffenes Format: 420 mm × 297 mm (A3)\n\tPapier: Multiart Silk Weiß\n\tGrammatur: 150 g/m²\n\tFarben: CMYK / CMYK\n\nEinhefter:\n\tSeiten: 4\n\tGeschlossenes Format: A4\n\tOffenes Format: 420 mm × 297 mm (A3)\n\tPapier: Multiart Silk Weiß\n\tGrammatur: 100 g/m²\n\tFarben: K, HKS 10 K / K, HKS 10 K\n\tWeiterverarbeitung: Perforieren\n\n\nWeiterverarbeitung: Rückendrahtheften",
        "qty": 1000,
        "unit": "piece",
        "net_total": -241014,
        "created_at": "2016-11-30T14:31:58.529+01:00",
        "updated_at": "2016-11-30T14:31:58.529+01:00",
        "tax_rate": "0.19",
        "gross_total": "-286807.0",
        "billable_id": 3261,
        "billable_type": "Product",
        "net": "-241.014",
        "discount": "0.0",
        "discounted_net_total": -241014,
        "order_number": "S9-NP-4E",
        "accounting_categories": [],
        "environmental_certifications": []
    }
]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/accounting/reversal_invoices/{reversal_invoice_id} get

The collection of ReversalInvoices.

get

Get a single ReversalInvoice record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

reversal_invoice_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
number: required(string)
If not specified, the invoice number is generated automatically.
net_total: required(integer)
gross_total: required(integer)
paid_at: required(date-only)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
custom_text: required(string)
taxes: required(object)
Contains the tax rates for each line item of the invoice
due_at: required(date-only)
If not specified, the due date will be set automatically, based on the specified payment terms.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
billed_at: required(date-only)
sent_at: required(date-only)
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
checked_at: required(datetime)
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the invoice
reversal_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reversed_invoice_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
type: required(string)
services_performed_at: required(date-only)
If not specified, the services date will be set automatically to the invoice date.
recipient: required(object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
recipient_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
recipient_type: required(string)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
line_items: required(array of response.LineItem)
Items: LineItem
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- invoice_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- description: required(string)
- qty: required(integer - minimum: 1)
- unit: required(pdf piece plate sheet folded_sheet meter sqmeter sqmillimeter millimeter liter milliliter gram kilogram ream minutes hours)
- net_total: required(integer)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- tax_rate: required(number - minimum: 0 - maximum: 1)
- gross_total: required(number)
- billable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- billable_type: required(string)
- net: required(number)
  For credit notes net, must be less than or equal to 0
- discount: required(number)
- discounted_net_total: required(integer)
- order_number: required(string)
- accounting_category_ids: required(array of any)
- environmental_certifications: required(string)

Example:

{
"id": 13668,
"number": "180411002",
"net_total": -96411,
"gross_total": -114729,
"paid_at": null,
"created_at": "2018-04-11T10:27:54.298+02:00",
"updated_at": "2018-04-11T10:27:54.356+02:00",
"custom_text": null,
"taxes": {
  "0.19": -18318
},
"due_at": "2018-04-11",
"printery_id": 17,
"billed_at": "2018-04-11",
"sent_at": null,
"business_unit_id": 23,
"custom_references": {},
"reversal_invoice_id": null,
"reversed_invoice_id": 13569,
"services_performed_at": "2018-03-26",
"recipient_type": "Organization",
"recipient_id": 6710,
"recipient": {
"id": 6710,
"name": "Crispy",
"tax_identifier": "DE 123456789",
"email": "crispy@example.com",
"reference": "Num 12345",
"debitor_identifier": null,
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2018-07-03T11:44:52.210+02:00",
"updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
"id": 1245,
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-07-19T13:44:16.332+02:00",
"updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
  "addressee": "Crispy Mountain GmbH",
  "street": "Emmerich Josef Straße",
  "number": "1a",
  "addition": "",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"line_items": [
  {
      "id": 19999,
      "invoice_id": 13668,
      "description": "Visitenkarte\nSeiten: 2\nFormat: 85 × 55 mm\nPapier: Kartei  U. Leitkarte Chamois chamois\nGrammatur: 250 g/m²\nFarben: CMYK / CMYK",
      "qty": 500,
      "unit": "piece",
      "net_total": -96411,
      "created_at": "2018-04-11T10:27:54.318+02:00",
      "updated_at": "2018-04-11T10:27:54.318+02:00",
      "tax_rate": "0.19",
      "gross_total": "-114729.0",
      "billable_id": 56046,
      "billable_type": "Product",
      "net": "-192.821",
      "discount": "0.0",
      "discounted_net_total": -96411,
      "order_number": "EB-9M-BR",
      "accounting_categories": [],
      "environmental_certifications": []
  }
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/customer_relations

/customer_relations/organizations get post

The collection of Organizations

get

Get a list of all Organization objects.

post

Create a new Organization object.

Get a list of all Organization objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Organization

name: required(string)
email: (string)
preferred_locale: (string)
A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
creditor_identifier: (string)
debitor_identifier: (string)
tax_identifier: (string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reference: (string)

Example:

[
{
"id": 7241,
"name": "Volksbank Mainz eG",
"tax_identifier": null,
"email": null,
"reference": "HCMZ19",
"debitor_identifier": null,
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2016-12-14T07:49:01.051+01:00",
"updated_at": "2016-12-14T10:47:15.384+01:00"
},
{
"id": 7250,
"name": "German Tax Office",
"tax_identifier": null,
"email": null,
"reference": "1069800",
"debitor_identifier": "10698",
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2016-12-14T08:05:33.983+01:00",
"updated_at": "2017-04-27T08:22:22.656+02:00"
},
{
"id": 6710,
"name": "Crispy",
"tax_identifier": "DE 123456789",
"email": "crispy@example.com",
"reference": "Num 12345",
"debitor_identifier": "",
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2018-07-03T11:44:52.210+02:00",
"updated_at": "2018-07-03T11:44:52.210+02:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Organization object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Body

Media type: application/json

Type: object

Properties

organization: required(object)
- name: (string)
- reference: (string)
- email: (string)
- tax_identifier: (string)
- debitor_identifier: (string)
- creditor_identifier: (string)
- preferred_locale: (string)

Example:

{
"organization": {
"name": "Crispy",
"reference": "Num 12345",
"email": "crispy@example.com",
"tax_identifier": "DE 123456789"
}
}

HTTP status code 201

This response is returned if creating a new Organization was successful.

Body

Media type: application/json

Type: object

Properties

name: required(string)
email: (string)
preferred_locale: (string)
A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
creditor_identifier: (string)
debitor_identifier: (string)
tax_identifier: (string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reference: (string)

Example:

{
"id": 6710,
"name": "Crispy",
"tax_identifier": "DE 123456789",
"email": "crispy@example.com",
"reference": "Num 12345",
"debitor_identifier": null,
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2018-07-03T11:44:52.210+02:00",
"updated_at": "2018-07-03T11:44:52.210+02:00"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/customer_relations/organizations/{organization_id} get patch

The collection of Organizations.

get

Get a single Organization record.

patch

Update the given Organization record with provided data.

Get a single Organization record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

organization_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string)
email: (string)
preferred_locale: (string)
A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
creditor_identifier: (string)
debitor_identifier: (string)
tax_identifier: (string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reference: (string)

Example:

{
"id": 6710,
"name": "Crispy",
"tax_identifier": "DE 123456789",
"email": "crispy@example.com",
"reference": "Num 12345",
"debitor_identifier": null,
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2018-07-03T11:44:52.210+02:00",
"updated_at": "2018-07-03T11:44:52.210+02:00"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Organization record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

organization_id: required(string)

Body

Media type: application/json

Type: object

Properties

organization: required(object)
- name: (string)
- reference: (string)
- email: (string)
- tax_identifier: (string)
- debitor_identifier: (string)
- creditor_identifier: (string)
- preferred_locale: (string)

Example:

{
"organization": {
"name": "Crispy",
"reference": "Num 12345",
"email": "crispy@example.com",
"tax_identifier": "DE 123456789"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/customer_relations/organizations/{organization_id}/people get post

The collection of People

get

Get a list of all Person objects.

post

Create a new Person object.

Get a list of all Person objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

organization_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Person

salutation: required(string)
first_name: required(string)
name: required(string)
email: (string)
phone: (string)
fax: (string)
mobile: (string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
debitor_identifier: (string)
tax_identifier: (string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reference: (string)
preferred_locale: (string)
A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.

Example:

[
{
"id": 1245,
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-07-19T13:44:16.332+02:00",
"updated_at": "2017-08-30T15:40:18.054+02:00"
},
{
"id": 1244,
"salutation": "Frau",
"name": "König",
"first_name": "Melanie",
"mobile": null,
"phone": "+4912345678",
"fax": null,
"tax_identifier": null,
"email": "melanie@example.com",
"reference": "A2NK84",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-11-17T12:25:23.479+01:00",
"updated_at": "2017-11-17T12:25:23.479+01:00"
},
{
"id": 1243,
"salutation": "Herr Dr.",
"name": "Christian",
"first_name": "Weyer",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "w@example.com",
"reference": "643D8V",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2016-12-14T07:50:45.625+01:00",
"updated_at": "2016-12-14T08:55:54.524+01:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Person object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

organization_id: required(string)

Body

Media type: application/json

Type: object

Properties

person: required(object)
- salutation: (string)
- first_name: required(string)
- name: required(string)
- email: required(string)
- phone: (string)
- fax: (string)
- mobile: (string)
- debitor_identifier: (string)
- preferred_locale: (string)
- tax_identifier: (string)
- reference: (string)

Example:

{
"person": {
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": "+4912345678",
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null
}
}

HTTP status code 201

This response is returned if creating a new Person was successful.

Body

Media type: application/json

Type: object

Properties

salutation: required(string)
first_name: required(string)
name: required(string)
email: (string)
phone: (string)
fax: (string)
mobile: (string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
debitor_identifier: (string)
tax_identifier: (string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reference: (string)
preferred_locale: (string)
A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.

Example:

{
"id": 1245,
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-07-19T13:44:16.332+02:00",
"updated_at": "2017-08-30T15:40:18.054+02:00"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/customer_relations/organizations/{organization_id}/people/{person_id} get patch delete

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.

Get a single Person record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

organization_id: required(string)
person_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

salutation: required(string)
first_name: required(string)
name: required(string)
email: (string)
phone: (string)
fax: (string)
mobile: (string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
debitor_identifier: (string)
tax_identifier: (string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reference: (string)
preferred_locale: (string)
A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.

Example:

{
"id": 1245,
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-07-19T13:44:16.332+02:00",
"updated_at": "2017-08-30T15:40:18.054+02:00"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Person record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

organization_id: required(string)
person_id: required(string)

Body

Media type: application/json

Type: object

Properties

person: required(object)
- salutation: (string)
- first_name: required(string)
- name: required(string)
- email: required(string)
- phone: (string)
- fax: (string)
- mobile: (string)
- debitor_identifier: (string)
- preferred_locale: (string)
- tax_identifier: (string)
- reference: (string)

Example:

{
"person": {
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": "+4912345678",
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Person record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

organization_id: required(string)
person_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration

/configuration/business_units get

The collection of BusinessUnits

get

Get a list of all BusinessUnit objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: BusinessUnit

name: required(string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
invoice_reply_to_email: (string)
offer_reply_to_email: (string)
material_delivery_reply_to_email: (string)
archive_email: (string)
terms: (string)
additional_document_information: (string)
email_signature: (string)
send_email_copies: required(boolean)
order_confirmation: required(one of automatically, manually, disabled)

Example:

[
{
"id": 29,
"name": "Druckmanufaktur",
"printery_id": 17,
"invoice_reply_to_email": null,
"offer_reply_to_email": null,
"material_delivery_reply_to_email": null,
"terms": null,
"additional_document_information": null,
"send_email_copies": false,
"email_signature": null,
"order_confirmation": "automatically",
"archive_email": null,
"created_at": "2016-07-11T12:59:00.208Z",
"updated_at": "2016-07-11T12:59:00.208Z",
"address": {
  "id": 633,
  "addressee": "Manufaktur GmbH",
  "street": "Musterstraße",
  "number": "12",
  "addition": null,
  "zip_code": "12345",
  "town": "Neustadt",
  "country_code": "DE",
  "fingerprint": "255c26145631a4917c20510807750806",
  "created_at": "2016-07-26T07:36:38.954Z",
  "updated_at": "2016-07-26T07:36:38.954Z"
}
},
{
"id": 23,
"name": "Druckerei Crispy",
"printery_id": 17,
"invoice_reply_to_email": null,
"offer_reply_to_email": null,
"material_delivery_reply_to_email": null,
"terms": "I. Geltungsbereich/VertragsschlussAufträge",
"additional_document_information": null,
"send_email_copies": false,
"email_signature": null,
"order_confirmation": "automatically",
"archive_email": null,
"created_at": "2016-05-30T07:30:51.188Z",
"updated_at": "2018-05-09T10:41:31.691Z",
"address": {
  "id": 552,
  "addressee": "Keyline Druckerei GmbH",
  "street": "Hauptstraße",
  "number": "1",
  "addition": null,
  "zip_code": "12345",
  "town": "Neustadt",
  "country_code": "DE",
  "fingerprint": "43092e95f3dc576800004b4e8534d372",
  "created_at": "2016-07-11T18:36:23.326Z",
  "updated_at": "2018-02-07T07:45:42.680Z"
}
},
{
"id": 50,
"name": "Crispy OnlineDruck",
"printery_id": 17,
"invoice_reply_to_email": null,
"offer_reply_to_email": null,
"material_delivery_reply_to_email": null,
"terms": null,
"additional_document_information": null,
"send_email_copies": false,
"email_signature": null,
"order_confirmation": "automatically",
"archive_email": null,
"created_at": "2016-10-15T10:35:12.024Z",
"updated_at": "2017-03-14T09:23:10.744Z",
"address": null
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/business_units/{business_unit_id} get

The collection of BusinessUnits.

get

Get a single BusinessUnit record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

business_unit_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
printery_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
invoice_reply_to_email: (string)
offer_reply_to_email: (string)
material_delivery_reply_to_email: (string)
archive_email: (string)
terms: (string)
additional_document_information: (string)
email_signature: (string)
send_email_copies: required(boolean)
order_confirmation: required(one of automatically, manually, disabled)

Example:

{
"id": 29,
"name": "Druckmanufaktur",
"printery_id": 17,
"invoice_reply_to_email": null,
"offer_reply_to_email": "",
"material_delivery_reply_to_email": "",
"terms": null,
"additional_document_information": null,
"send_email_copies": false,
"email_signature": null,
"order_confirmation": "automatically",
"archive_email": null,
"created_at": "2016-07-11T12:59:00.208Z",
"updated_at": "2016-07-11T12:59:00.208Z",
"address": {
"id": 633,
"addressee": "Manufaktur GmbH",
"street": "Musterstraße",
"number": "12",
"addition": null,
"zip_code": "12345",
"town": "Neustadt",
"country_code": "DE",
"fingerprint": "255c26145631a4917c20510807750806",
"created_at": "2016-07-26T07:36:38.954Z",
"updated_at": "2016-07-26T07:36:38.954Z"
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/business_units/{business_unit_id}/carriers get post

The collection of Carriers

get

Get a list of all Carrier objects.

post

Create a new Carrier object.

Get a list of all Carrier objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

business_unit_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Carrier

name: required(string)
service: required(string)
automated_labels: required(boolean)
bill_individual_parcels: required(boolean)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

[
{
"id": 18,
"name": "Selbstauslieferung",
"service": "Standard",
"automated_labels": false,
"bill_individual_parcels": false,
"created_at": "2016-10-11T20:07:35.966Z",
"updated_at": "2018-07-29T16:04:53.562Z"
},
{
"id": 12,
"name": "DHL",
"service": "Standard",
"automated_labels": true,
"bill_individual_parcels": false,
"created_at": "2016-09-26T11:05:48.887Z",
"updated_at": "2018-10-02T06:48:41.847Z"
},
{
"id": 17,
"name": "UPS",
"service": "Standard",
"automated_labels": true,
"bill_individual_parcels": false,
"created_at": "2016-10-11T20:07:26.205Z",
"updated_at": "2018-10-02T06:48:41.912Z"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Carrier object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

business_unit_id: required(string)

Body

Media type: application/json

Type: object

Properties

name: required(string)
Name of the carrier, which must be one of a pre-defined list of carriers, which is specific to the country the printery operates in.
service: required(string)
Specifies which service of the Carrier, which is given in name, should be used when this carrier instance is selected for sending a shipment. This depends on the country the printery operates in and the carrier, but is usually one of the following values: 'Standard', 'Express', 'Morning Express'
automated_labels: (boolean)
bill_individual_parcels: (boolean)
supported_countries: required(array of string)
List of ISO Country codes to which this carrier will be able to send shipments to.

Example:

{
"carrier": {
"name": "DHL",
"service": "Standard",
"supported_countries": ["DE"]
}
}

HTTP status code 201

This response is returned if creating a new Carrier was successful.

Body

Media type: application/json

Type: object

Properties

name: required(string)
service: required(string)
automated_labels: required(boolean)
bill_individual_parcels: required(boolean)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 12,
"name": "DHL",
"service": "Standard",
"automated_labels": true,
"bill_individual_parcels": false,
"created_at": "2016-09-26T11:05:48.887Z",
"updated_at": "2018-10-02T06:48:41.847Z"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/business_units/{business_unit_id}/carriers/{carrier_id} get patch delete

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.

Get a single Carrier record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

business_unit_id: required(string)
carrier_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string)
service: required(string)
automated_labels: required(boolean)
bill_individual_parcels: required(boolean)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 12,
"name": "DHL",
"service": "Standard",
"automated_labels": true,
"bill_individual_parcels": false,
"created_at": "2016-09-26T11:05:48.887Z",
"updated_at": "2018-10-02T06:48:41.847Z"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Carrier record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

business_unit_id: required(string)
carrier_id: required(string)

Body

Media type: application/json

Type: object

Properties

name: required(string)
Name of the carrier, which must be one of a pre-defined list of carriers, which is specific to the country the printery operates in.
service: required(string)
Specifies which service of the Carrier, which is given in name, should be used when this carrier instance is selected for sending a shipment. This depends on the country the printery operates in and the carrier, but is usually one of the following values: 'Standard', 'Express', 'Morning Express'
automated_labels: (boolean)
bill_individual_parcels: (boolean)
supported_countries: required(array of string)
List of ISO Country codes to which this carrier will be able to send shipments to.

Example:

{
"carrier": {
"name": "DHL",
"service": "Standard",
"supported_countries": ["DE"]
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Carrier record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

business_unit_id: required(string)
carrier_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/stock_finishings get

The collection of StockFinishings

get

Get a list of all StockFinishing objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Stock Finishing

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
kind: required(string)
permitted_finishable_type: required(one of product, component, any)
To what kind of object can this finishing be applied? A Product or Component only, or any kind.
properties: required(array of response.FinishingProperty)
Items: Finishing Property
- key: required(string)
- show_to_customer: required(boolean)
- kind: required(one of boolean, integer, float, string)
- unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
common: required(boolean)

Example:

[
{
    "id": 628,
    "kind": "Cellophaning",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T08:54:37.216Z",
    "updated_at": "2018-02-01T10:40:03.001Z",
    "common": true
},
{
    "id": 627,
    "kind": "Chipping",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:50:57.734Z",
    "updated_at": "2018-02-01T07:50:57.734Z",
    "common": true
},
{
    "id": 634,
    "kind": "Collecting",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:39:32.100Z",
    "updated_at": "2018-02-01T10:39:32.100Z",
    "common": true
},
{
    "id": 617,
    "kind": "Concealing",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:34:39.138Z",
    "updated_at": "2018-02-01T07:34:53.163Z",
    "common": true
},
{
    "id": 611,
    "kind": "Corner rounding",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of corners",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:27:29.312Z",
    "updated_at": "2018-02-01T07:28:05.249Z",
    "common": true
},
{
    "id": 623,
    "kind": "Creasing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of creasing rules",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:46:25.684Z",
    "updated_at": "2018-02-01T07:48:30.130Z",
    "common": true
},
{
    "id": 610,
    "kind": "Dispersion coating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:26:30.721Z",
    "updated_at": "2018-02-01T07:30:23.004Z",
    "common": true
},
{
    "id": 532,
    "kind": "Drilling",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of holes",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-15T11:46:57.146Z",
    "updated_at": "2018-02-01T07:18:24.983Z",
    "common": true
},
{
    "id": 607,
    "kind": "Embossing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per embossing stamp",
            "kind": "float",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:17:13.441Z",
    "updated_at": "2018-02-01T07:18:04.204Z",
    "common": true
},
{
    "id": 619,
    "kind": "Eyelet binding",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of eyelets",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:38:34.090Z",
    "updated_at": "2018-02-01T07:39:01.151Z",
    "common": true
},
{
    "id": 608,
    "kind": "Foil embossing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per embossing stamp",
            "kind": "float",
            "show_to_customer": false
        },
        {
            "key": "Embossing area",
            "kind": "float",
            "unit": "sqmillimeter",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:18:42.585Z",
    "updated_at": "2018-02-01T07:20:04.464Z",
    "common": true
},
{
    "id": 614,
    "kind": "Glueing",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:31:46.318Z",
    "updated_at": "2018-02-01T07:32:00.425Z",
    "common": true
},
{
    "id": 609,
    "kind": "Laminating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:20:37.828Z",
    "updated_at": "2018-02-01T07:30:42.497Z",
    "common": true
},
{
    "id": 632,
    "kind": "Numbering",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:38:42.281Z",
    "updated_at": "2018-02-01T10:38:49.758Z",
    "common": true
},
{
    "id": 613,
    "kind": "Perfect binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:31:06.078Z",
    "updated_at": "2018-02-01T07:31:27.336Z",
    "common": true
},
{
    "id": 533,
    "kind": "Perforating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of perforation lines",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-15T11:59:34.318Z",
    "updated_at": "2018-02-01T07:48:58.589Z",
    "common": true
},
{
    "id": 620,
    "kind": "Punching",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per punch form",
            "kind": "float",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:39:57.872Z",
    "updated_at": "2018-02-01T07:40:38.822Z",
    "common": true
},
{
    "id": 615,
    "kind": "Punch numbering",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:33:24.399Z",
    "updated_at": "2018-02-01T07:33:38.735Z",
    "common": true
},
{
    "id": 621,
    "kind": "Saddle stitching",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of stitchings",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:40:58.742Z",
    "updated_at": "2018-02-01T15:46:09.246Z",
    "common": true
},
{
    "id": 612,
    "kind": "Shrink wrapping",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:28:27.780Z",
    "updated_at": "2018-02-01T08:55:05.120Z",
    "common": true
},
{
    "id": 624,
    "kind": "Spiral binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:49:37.327Z",
    "updated_at": "2018-02-01T07:49:46.892Z",
    "common": true
},
{
    "id": 625,
    "kind": "Thermo binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:50:34.325Z",
    "updated_at": "2018-02-01T07:50:34.325Z",
    "common": true
},
{
    "id": 618,
    "kind": "Thread stitching",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:37:45.372Z",
    "updated_at": "2018-02-01T07:37:55.546Z",
    "common": true
},
{
    "id": 622,
    "kind": "UV coating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:45:33.649Z",
    "updated_at": "2018-02-01T07:45:44.197Z",
    "common": true
},
{
    "id": 543,
    "kind": "Varnishing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-24T10:13:11.424Z",
    "updated_at": "2018-02-01T10:37:13.158Z",
    "common": true
},
{
    "id": 630,
    "kind": "Wire-o binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:37:21.870Z",
    "updated_at": "2018-02-01T10:37:35.640Z",
    "common": true
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/stock_substrates get post

The collection of StockSubstrates

get

Get a list of all StockSubstrate objects.

post

Create a new StockSubstrate object.

Get a list of all StockSubstrate objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Stock Substrate

name: required(string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
material_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
dimensions: required(array of integer - minItems: 2 - maxItems: 2)
The dimensions of the paper in mm, where the first element of the array is the width and the second being height.
grain: (one of long, short)
grammage: required(integer - minimum: 1)
Grammage of the paper (in gsm)
color_saturation: required(number - minimum: 0)
color: required(string)
A string describing the color. These are usually not comparable across suppliers.
thickness: (integer)
category: (string)
Describes the category of substrate that is represented by this object as a string.
kind: (string)
Describes the kind of substrate that is represented by this object as a string.
environmental_certification: (one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
texture: (string)
A string describing the texture of the substrate. These are usually not comparable across suppliers.
delivered_precut: (boolean)

Example:

[
{
"id": 20083,
"name": "Affichenpapier Rs Blau",
"dimensions": [
  630,
  880
],
"grain": "long",
"grammage": 115,
"color_saturation": null,
"color": "weiß",
"thickness": null,
"category": "Bilderdruckpapier",
"kind": "sheet",
"environmental_certification": null,
"texture": null,
"delivered_precut": false,
"created_at": "2016-09-06T16:48:25.349+02:00",
"updated_at": "2017-07-19T13:37:26.226+02:00",
"material_id": 69557,
},
{
"id": 15078,
"name": "Alaska Plus",
"dimensions": [
  720,
  1020
],
"grain": "long",
"grammage": 235,
"color_saturation": null,
"color": "weiß",
"thickness": null,
"category": "Naturpapier matt",
"kind": "sheet",
"environmental_certification": null,
"texture": null,
"delivered_precut": false,
"created_at": "2016-08-31T23:05:50.383+02:00",
"updated_at": "2017-03-24T15:15:12.102+01:00",
"material_id": 69224,
},
{
"id": 15082,
"name": "Alaska Plus",
"dimensions": [
  720,
  1020
],
"grain": "long",
"grammage": 280,
"color_saturation": null,
"color": "weiß",
"thickness": null,
"category": "Naturpapier matt",
"kind": "sheet",
"environmental_certification": null,
"texture": null,
"delivered_precut": false,
"created_at": "2016-08-31T23:05:51.751+02:00",
"updated_at": "2017-03-24T15:15:13.030+01:00",
"material_id": 69228,
},
{
"id": 15083,
"name": "Alaska Plus",
"dimensions": [
  1020,
  720
],
"grain": "short",
"grammage": 280,
"color_saturation": null,
"color": "weiß",
"thickness": null,
"category": "Naturpapier matt",
"kind": "sheet",
"environmental_certification": null,
"texture": null,
"delivered_precut": false,
"created_at": "2016-08-31T23:05:52.090+02:00",
"updated_at": "2017-03-24T15:15:13.273+01:00",
"material_id": 69229,
},
{
"id": 21690,
"name": "Algro Design",
"dimensions": [
  720,
  1020
],
"grain": "long",
"grammage": 160,
"color_saturation": null,
"color": "weiß",
"thickness": 181,
"category": null,
"kind": "sheet",
"environmental_certification": "FSC Mix Credit",
"texture": null,
"delivered_precut": false,
"created_at": "2016-09-06T16:55:55.649+02:00",
"updated_at": "2016-09-06T16:55:55.649+02:00",
"material_id": 70227,
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new StockSubstrate object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Body

Media type: application/json

Type: object

Properties

stock_substrate: required(object)
- name: required(string)
- dimensions: required(array of integer - minItems: 2 - maxItems: 2)
  The dimensions of the substrate in mm, where the first element of the array is the width and the second being height.
- grain: (one of long, short)
- grammage: required(integer - minimum: 1)
  Grammage of the substrate (in gsm)
- color_saturation: (number - minimum: 0)
- color: required(string)
  A string describing the color. These are usually not comparable across suppliers.
- thickness: (integer)
- category: (string)
  Describes the category of the substrate that is represented by this object as a string.
- kind: (string)
  Describes the kind of the substrate that is represented by this object as a string.
- environmental_certification: (one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
- texture: (string)
  A string describing the texture of the substrate. These are usually not comparable across suppliers.
- delivered_precut: (boolean)

Example:

{
"stock_substrate": {
"name": "Conqueror Cx22",
"dimensions": [640, 450],
"category": "Naturpapier matt",
"grain": null,
"color": "Brilliant White",
"grammage": 100,
"thickness": 0
}
}

HTTP status code 201

This response is returned if creating a new StockSubstrate was successful.

Body

Media type: application/json

Type: object

Properties

name: required(string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
material_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
dimensions: required(array of integer - minItems: 2 - maxItems: 2)
The dimensions of the paper in mm, where the first element of the array is the width and the second being height.
grain: (one of long, short)
grammage: required(integer - minimum: 1)
Grammage of the paper (in gsm)
color_saturation: required(number - minimum: 0)
color: required(string)
A string describing the color. These are usually not comparable across suppliers.
thickness: (integer)
category: (string)
Describes the category of substrate that is represented by this object as a string.
kind: (string)
Describes the kind of substrate that is represented by this object as a string.
environmental_certification: (one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
texture: (string)
A string describing the texture of the substrate. These are usually not comparable across suppliers.
delivered_precut: (boolean)

Example:

{
"id": 15078,
"name": "Alaska Plus",
"dimensions": [
720,
1020
],
"grain": "long",
"grammage": 235,
"color_saturation": null,
"color": "weiß",
"thickness": null,
"category": "Naturpapier matt",
"kind": "sheet",
"environmental_certification": null,
"texture": null,
"delivered_precut": false,
"created_at": "2016-08-31T23:05:50.383+02:00",
"updated_at": "2017-03-24T15:15:12.102+01:00",
"material_id": 69224
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/stock_substrates/{stock_substrate_id} get patch delete

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 a single StockSubstrate record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

stock_substrate_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string)
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
material_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
dimensions: required(array of integer - minItems: 2 - maxItems: 2)
The dimensions of the paper in mm, where the first element of the array is the width and the second being height.
grain: (one of long, short)
grammage: required(integer - minimum: 1)
Grammage of the paper (in gsm)
color_saturation: required(number - minimum: 0)
color: required(string)
A string describing the color. These are usually not comparable across suppliers.
thickness: (integer)
category: (string)
Describes the category of substrate that is represented by this object as a string.
kind: (string)
Describes the kind of substrate that is represented by this object as a string.
environmental_certification: (one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
texture: (string)
A string describing the texture of the substrate. These are usually not comparable across suppliers.
delivered_precut: (boolean)

Example:

{
"id": 15078,
"name": "Alaska Plus",
"dimensions": [
720,
1020
],
"grain": "long",
"grammage": 235,
"color_saturation": null,
"color": "weiß",
"thickness": null,
"category": "Naturpapier matt",
"kind": "sheet",
"environmental_certification": null,
"texture": null,
"delivered_precut": false,
"created_at": "2016-08-31T23:05:50.383+02:00",
"updated_at": "2017-03-24T15:15:12.102+01:00",
"material_id": 69224
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given StockSubstrate record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

stock_substrate_id: required(string)

Body

Media type: application/json

Type: object

Properties

stock_substrate: required(object)
- name: required(string)
- dimensions: required(array of integer - minItems: 2 - maxItems: 2)
  The dimensions of the substrate in mm, where the first element of the array is the width and the second being height.
- grain: (one of long, short)
- grammage: required(integer - minimum: 1)
  Grammage of the substrate (in gsm)
- color_saturation: (number - minimum: 0)
- color: required(string)
  A string describing the color. These are usually not comparable across suppliers.
- thickness: (integer)
- category: (string)
  Describes the category of the substrate that is represented by this object as a string.
- kind: (string)
  Describes the kind of the substrate that is represented by this object as a string.
- environmental_certification: (one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
- texture: (string)
  A string describing the texture of the substrate. These are usually not comparable across suppliers.
- delivered_precut: (boolean)

Example:

{
"stock_substrate": {
"name": "Conqueror Cx22",
"dimensions": [640, 450],
"category": "Naturpapier matt",
"grain": null,
"color": "Brilliant White",
"grammage": 100,
"thickness": 0
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given StockSubstrate record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

stock_substrate_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/product_templates get

get

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

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string)
kind: required(string)
order_number: required(string)
description: required(string)
automated_billing: required(boolean)
product: required(object)
A single printed product identified by a name and made up of multiple components, which usually can be manufactured separately.
- name: required(string - minLength: 1 - maxLength: 200)
- order_id: required(integer)
  The id of the order, this product belongs to.
- reference: required(string - pattern: ^[0-9A-Z]{6}$)
  A 6-character, alphanumeric string, that uniquely identifies an object.
  Example:
```
N4XTC8
```
- custom_references: required(object)
  Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
- state: required(one of draft, prepress, press, postpress, packing, shipping, completed, exception, canceled)
  Denotes the state which the product is currently in
- kind: required(one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
  The kind of product
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 1,
"name": "Broschüre (Klebebindung)",
"kind": "Broschüre",
"order_number": null,
"description": null,
"automated_billing": false,
"created_at": "2017-02-14T22:56:07.379Z",
"updated_at": "2017-02-14T22:56:07.379Z",
"product": {
  "id": 6039,
  "order_id": null,
  "reference": "MBVG1M",
  "custom_references": {},
  "state": "completed",
  "name": "Broschüre (Klebebindung)",
  "kind": "Broschüre",
  "created_at": "2017-02-14T22:56:07.381Z",
  "updated_at": "2017-02-14T22:56:07.381Z"
}
},
{
"id": 2,
"name": "Visitenkarte, kaschiert",
"kind": "Visitenkarte",
"order_number": null,
"description": null,
"automated_billing": false,
"created_at": "2017-02-14T22:56:07.680Z",
"updated_at": "2017-09-01T11:08:44.821Z",
"product": {
  "id": 6040,
  "order_id": null,
  "reference": "BP3HV7",
  "custom_references": {},
  "state": "draft",
  "name": "Visitenkarte, kaschiert",
  "kind": "Visitenkarte",
  "created_at": "2017-02-14T22:56:07.682Z",
  "updated_at": "2017-02-14T22:56:07.682Z"
}
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/service_templates get

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.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

kind: required(string)
This describes the kind of service that is defined by this template. It must be unique within the printery, as it uniquely identifies the service template.
category: required(one of prepress, image_editing, typesetting, layout, proofreading, digital_proof, other)
Describes which kind of service this template defines.
unit: required(one of hours, minutes, pieces)
Denotes which unit the costs are given in.
costs_per_unit: required(integer)
The costs per unit, given in the smallest unit currency of the printery ('cents' in case of EUR).
completion_required_for: required(one of none, prepress, press, postpress)
If a service that is derived from a service template that has completion_required_for set to some other value than none is added to a product, then production of the product will be halted at the respective stage, until the task for this service is marked as completed.
This effectively makes services based on this service template a kind of quality gate.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 1,
"kind": "DTP",
"category": "layout",
"unit": "hours",
"costs_per_unit": 3000,
"completion_required_for": "none",
"created_at": "2017-11-09T09:02:19.975Z",
"updated_at": "2017-11-09T10:07:05.520Z"
},
{
"id": 2,
"kind": "Bildrecherche",
"category": "image_editing",
"unit": "hours",
"costs_per_unit": 2000,
"completion_required_for": "none",
"created_at": "2017-11-09T10:02:48.031Z",
"updated_at": "2017-11-09T10:06:50.592Z"
},
{
"id": 3,
"kind": "Bildbearbeitung",
"category": "image_editing",
"unit": "hours",
"costs_per_unit": 1000,
"completion_required_for": "none",
"created_at": "2017-11-09T10:08:01.572Z",
"updated_at": "2017-11-09T10:08:01.572Z"
},
{
"id": 4,
"kind": "Druckdaten erstellen",
"category": "typesetting",
"unit": "hours",
"costs_per_unit": 1000,
"completion_required_for": "none",
"created_at": "2017-11-09T10:09:02.366Z",
"updated_at": "2017-11-09T10:09:02.366Z"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/configuration/printery get

get

Returns all printery-wide settings.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string)
country_code: required(one of DE, AT, CH, UK, LV)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
template_access: required(one of full, just_papers_and_basics, just_basics)
default_imposing_margin: (integer - minimum: 1 - maximum: 100)
Imposing margin that is applied to all imposings by default (in mm).
formula_for_contribution_margin_for_inhouse_costs: (string)
formula_for_contribution_margin_for_external_costs: (string)
production_scheduling_days_in_advance: required(integer)
production_scheduling_generations: required(integer)
production_scheduling_meet_deadline_importance: required(integer)
production_scheduling_minimize_splits_importance: required(integer)
production_scheduling_pool_materials_importance: required(integer)
production_scheduling_minimize_time_importance: required(integer)

Example:

{
"name": "Crispy Mountain Printery",
"country_code": "DE",
"default_imposing_margin": null,
"template_access": "full",
"created_at": "2016-05-30T09:30:51.139+02:00",
"updated_at": "2017-11-29T10:02:41.395+01:00",
"formula_for_contribution_margin_for_inhouse_costs": null,
"formula_for_contribution_margin_for_external_costs": null,
"production_scheduling_days_in_advance": 5,
"production_scheduling_generations": 25,
"production_scheduling_meet_deadline_importance": 12,
"production_scheduling_minimize_splits_importance": 12,
"production_scheduling_pool_materials_importance": 50,
"production_scheduling_minimize_time_importance": 26
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/sales

/sales/orders get post

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.

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.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Order

custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the order
custom_offer_text: (string)
An additional string that should appear on the offer to the customer.
due_at: (datetime)
The point in time until which the order must be delivered to the customer.
products: required(array of response.Product)
Items: Product
- name: required(string - minLength: 1 - maxLength: 200)
- order_id: required(integer)
  The id of the order, this product belongs to.
- reference: required(string - pattern: ^[0-9A-Z]{6}$)
  A 6-character, alphanumeric string, that uniquely identifies an object.
  Example:
```
N4XTC8
```
- custom_references: required(object)
  Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
- state: required(one of draft, prepress, press, postpress, packing, shipping, completed, exception, canceled)
  Denotes the state which the product is currently in
- kind: required(one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
  The kind of product
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
contact: (object)
Describes a natural person
- salutation: required(string)
- first_name: required(string)
- name: required(string)
- email: (string)
- phone: (string)
- fax: (string)
- mobile: (string)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
address: (object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
customer: (object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 16054,
"reference": "VGQGB4",
"custom_references": {
  "Besteller": "Knusper Berg"
},
"custom_offer_text": null,
"due_at": null,
"created_at": "2017-11-28T17:44:21.526+01:00",
"updated_at": "2017-12-04T08:26:14.592+01:00",
"customer_id": 6710,
"customer_type": "Organization",
"customer": {
  "id": 6710,
  "name": "Crispy",
  "tax_identifier": "DE 123456789",
  "email": "crispy@example.com",
  "reference": "Num 12345",
  "debitor_identifier": null,
  "creditor_identifier": null,
  "preferred_locale": null,
  "created_at": "2018-07-03T11:44:52.210+02:00",
  "updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
  "id": 1245,
  "salutation": "Frau",
  "name": "Schöller",
  "first_name": "Maria",
  "mobile": null,
  "phone": null,
  "fax": null,
  "tax_identifier": null,
  "email": "maria@example.com",
  "reference": "HAXEZ3",
  "debitor_identifier": null,
  "preferred_locale": null,
  "created_at": "2017-07-19T13:44:16.332+02:00",
  "updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
  "addressee": "Crispy Mountain GmbH",
  "street": "Emmerich Josef Straße",
  "number": "1a",
  "addition": "",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"products": [
  {
    "id": 23511,
    "order_id": 16054,
    "reference": "CHC71H",
    "custom_references": {},
    "state": "draft",
    "name": "New Product",
    "kind": "book",
    "created_at": "2017-11-28T17:44:49.868+01:00",
    "updated_at": "2017-11-28T17:44:49.868+01:00"
  }
]
},
{
"id": 13013,
"reference": "NC8G8E",
"custom_references": {},
"custom_offer_text": null,
"due_at": null,
"created_at": "2017-10-17T11:47:54.764+02:00",
"updated_at": "2017-10-17T11:47:54.764+02:00",
"address": null,
"customer_id": null,
"customer_type": null,
"contact": null,
"products": [
  {
    "id": 20012,
    "order_id": 13013,
    "reference": "G62ZTU",
    "custom_references": {},
    "state": "draft",
    "name": "Blatt",
    "kind": "custom",
    "created_at": "2017-10-17T11:48:09.478+02:00",
    "updated_at": "2017-10-17T11:48:09.478+02:00"
  }
]
},
{
"id": 12359,
"reference": "ZRHFZW",
"custom_references": {},
"custom_offer_text": null,
"due_at": null,
"created_at": "2017-10-04T11:49:01.273+02:00",
"updated_at": "2017-10-04T11:57:01.596+02:00",
"address": {
  "addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
  "street": "Emmerich-Josef-Str.",
  "number": "1a",
  "addition": "Hinterhaus",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"customer_id": 6710,
"customer_type": "Organization",
"customer": {
  "id": 6710,
  "name": "Crispy",
  "tax_identifier": "DE 123456789",
  "email": "crispy@example.com",
  "reference": "Num 12345",
  "debitor_identifier": null,
  "creditor_identifier": null,
  "preferred_locale": null,
  "created_at": "2018-07-03T11:44:52.210+02:00",
  "updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
  "id": 1245,
  "salutation": "Frau",
  "name": "Schöller",
  "first_name": "Maria",
  "mobile": null,
  "phone": null,
  "fax": null,
  "tax_identifier": null,
  "email": "maria@example.com",
  "reference": "HAXEZ3",
  "debitor_identifier": null,
  "preferred_locale": null,
  "created_at": "2017-07-19T13:44:16.332+02:00",
  "updated_at": "2017-08-30T15:40:18.054+02:00"
},
"products": [
  {
    "id": 19145,
    "order_id": 12359,
    "reference": "K7KD1D",
    "custom_references": {},
    "state": "draft",
    "name": "Great Stickers",
    "kind": "sticker",
    "created_at": "2017-10-04T11:51:40.845+02:00",
    "updated_at": "2017-10-04T11:51:40.845+02:00"
  }
]
},
{
"id": 12314,
"reference": "T3EPVR",
"custom_references": {},
"custom_offer_text": null,
"due_at": null,
"created_at": "2017-10-02T15:47:37.663+02:00",
"updated_at": "2017-10-02T15:47:37.663+02:00",
"address": null,
"customer": null,
"contact": null,
"products": [
  {
    "id": 19088,
    "order_id": 12314,
    "reference": "MQKX72",
    "custom_references": {},
    "state": "draft",
    "name": "Visitenkarte",
    "kind": "business_card",
    "created_at": "2017-10-02T15:47:43.213+02:00",
    "updated_at": "2017-10-02T15:47:43.213+02:00"
  },
  {
    "id": 19089,
    "order_id": 12314,
    "reference": "8UU1DR",
    "custom_references": {},
    "state": "draft",
    "name": "Visitenkarte (basiert auf MQKX72)",
    "kind": "business_card",
    "created_at": "2017-10-02T15:48:32.623+02:00",
    "updated_at": "2017-10-02T15:48:32.623+02:00"
  }
]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Order object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Body

Media type: application/json

Type: object

Properties

order: required(object)
- custom_references: (object)
  Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the order
- custom_offer_text: (string)
  An additional string that should appear on the offer to the customer.
- due_at: (datetime)
  The point in time until which the order must be delivered to the customer.
- business_unit_id: (integer)
  The id of the business unit this order should be associated to. If not specified, the standard business unit is set.
- customer_id: (integer)
  The id of the customer this order should be associated to.
- contact_id: (integer)
  The id of the contact this order should be associated to.

Example:

{
"order": {
"custom_references": {
  "Ordering Person": "Ms Stark"
},
"custom_offer_text": "This is urgent",
"due_at": "2017-12-12T17:00:00+02:00",
"customer_id": 57
}
}

HTTP status code 201

This response is returned if creating a new Order was successful.

Body

Media type: application/json

Type: object

Properties

custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the order
custom_offer_text: (string)
An additional string that should appear on the offer to the customer.
due_at: (datetime)
The point in time until which the order must be delivered to the customer.
products: required(array of response.Product)
Items: Product
- name: required(string - minLength: 1 - maxLength: 200)
- order_id: required(integer)
  The id of the order, this product belongs to.
- reference: required(string - pattern: ^[0-9A-Z]{6}$)
  A 6-character, alphanumeric string, that uniquely identifies an object.
  Example:
```
N4XTC8
```
- custom_references: required(object)
  Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
- state: required(one of draft, prepress, press, postpress, packing, shipping, completed, exception, canceled)
  Denotes the state which the product is currently in
- kind: required(one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
  The kind of product
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
contact: (object)
Describes a natural person
- salutation: required(string)
- first_name: required(string)
- name: required(string)
- email: (string)
- phone: (string)
- fax: (string)
- mobile: (string)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
address: (object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
customer: (object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 16054,
"reference": "VGQGB4",
"custom_references": {},
"custom_offer_text": null,
"due_at": null,
"created_at": "2017-11-28T17:44:21.526+01:00",
"updated_at": "2017-12-04T08:26:14.592+01:00",
"address": null,
"customer_id": null,
"customer_type": null,
"contact": null,
"products": []
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/sales/orders/{order_id} get patch delete

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.

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.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

order_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the order
custom_offer_text: (string)
An additional string that should appear on the offer to the customer.
due_at: (datetime)
The point in time until which the order must be delivered to the customer.
products: required(array of response.Product)
Items: Product
- name: required(string - minLength: 1 - maxLength: 200)
- order_id: required(integer)
  The id of the order, this product belongs to.
- reference: required(string - pattern: ^[0-9A-Z]{6}$)
  A 6-character, alphanumeric string, that uniquely identifies an object.
  Example:
```
N4XTC8
```
- custom_references: required(object)
  Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
- state: required(one of draft, prepress, press, postpress, packing, shipping, completed, exception, canceled)
  Denotes the state which the product is currently in
- kind: required(one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
  The kind of product
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
contact: (object)
Describes a natural person
- salutation: required(string)
- first_name: required(string)
- name: required(string)
- email: (string)
- phone: (string)
- fax: (string)
- mobile: (string)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
address: (object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
customer: (object)
A Organization object represents a customer of a printery
- name: required(string)
- email: (string)
- preferred_locale: (string)
  A two-letter ISO country code, that identifies the language the person or organization prefers to be contacted with.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- creditor_identifier: (string)
- debitor_identifier: (string)
- tax_identifier: (string)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- reference: (string)
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
business_unit_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 16054,
"reference": "VGQGB4",
"custom_references": {
"Besteller": "Knusper Berg"
},
"custom_offer_text": null,
"due_at": null,
"created_at": "2017-11-28T17:44:21.526+01:00",
"updated_at": "2017-12-04T08:26:14.592+01:00",
"customer_id": 6710,
"customer_type": "Organization",
"customer": {
"id": 6710,
"name": "Crispy",
"tax_identifier": "DE 123456789",
"email": "crispy@example.com",
"reference": "Num 12345",
"debitor_identifier": null,
"creditor_identifier": null,
"preferred_locale": null,
"created_at": "2018-07-03T11:44:52.210+02:00",
"updated_at": "2018-07-03T11:44:52.210+02:00"
},
"contact": {
"id": 1245,
"salutation": "Frau",
"name": "Schöller",
"first_name": "Maria",
"mobile": null,
"phone": null,
"fax": null,
"tax_identifier": null,
"email": "maria@example.com",
"reference": "HAXEZ3",
"debitor_identifier": null,
"preferred_locale": null,
"created_at": "2017-07-19T13:44:16.332+02:00",
"updated_at": "2017-08-30T15:40:18.054+02:00"
},
"address": {
"addressee": "Crispy Mountain GmbH",
"street": "Emmerich Josef Straße",
"number": "1a",
"addition": "",
"zip_code": "55116",
"town": "Mainz",
"country_code": "DE"
},
"products": [
{
  "id": 23511,
  "order_id": 16054,
  "reference": "CHC71H",
  "custom_references": {},
  "state": "draft",
  "name": "New Product",
  "kind": "book",
  "created_at": "2017-11-28T17:44:49.868+01:00",
  "updated_at": "2017-11-28T17:44:49.868+01:00"
}
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for a single draft order.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

order_id: required(string)

Body

Media type: application/json

Type: object

Properties

order: required(object)
- custom_references: (object)
  Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the order
- custom_offer_text: (string)
  An additional string that should appear on the offer to the customer.
- due_at: (datetime)
  The point in time until which the order must be delivered to the customer.
- business_unit_id: (integer)
  The id of the business unit this order should be associated to. If not specified, the standard business unit is set.
- customer_id: (integer)
  The id of the customer this order should be associated to.
- contact_id: (integer)
  The id of the contact this order should be associated to.

Example:

{
"order": {
"custom_references": {
  "Ordering Person": "Ms Stark"
},
"custom_offer_text": "This is urgent",
"due_at": "2017-12-12T17:00:00+02:00",
"customer_id": 57
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete a draft order.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

order_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/sales/orders/{order_id}/address post patch

The Address record associated with the parent record.

post

Create a new Address record.

patch

Update details for an address.

Create a new Address record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

order_id: required(string)

Body

Media type: application/json

Type: object

Properties

address: required(object)
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information

Example:

{
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Straße",
    "number": "1a",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
}
}

HTTP status code 201

This response is returned if creating a new Address was successful.

Body

Media type: application/json

Type: object

Properties

addressee: required(string)
town: required(string)
number: (string)
country_code: required(string)
ISO Country code of country this address is located in.
zip_code: required(string)
street: (string)
addition: (string)
An optional additional information, usually displayed right below the address.

Example:

{
"id": 195900,
"addressee": "Crispy Mountain GmbH",
"street": "Emmerich-Josef-Straße",
"number": "1a",
"addition": null,
"zip_code": "55116",
"town": "Mainz",
"country_code": "DE",
"fingerprint": "0bd0c67b086f05346dac284e606c4d30",
"created_at": "2019-06-27T13:25:52.423Z",
"updated_at": "2019-07-01T11:04:16.228Z"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update details for an address.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

order_id: required(string)

Body

Media type: application/json

Type: object

Properties

address: required(object)
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information

Example:

{
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Straße",
    "number": "1a",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/sales/orders/{order_id}/products get post

The collection of Products

get

Get a list of all Product objects.

post

Create a new Product object.

Get a list of all Product objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

order_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Product

name: required(string - minLength: 1 - maxLength: 200)
order_id: required(integer)
The id of the order, this product belongs to.
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
state: required(one of draft, prepress, press, postpress, packing, shipping, completed, exception, canceled)
Denotes the state which the product is currently in
kind: required(one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
The kind of product
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 23426,
"order_id": 15532,
"reference": "VRHKQH",
"custom_references": {},
"state": "draft",
"name": "Visitenkarte",
"kind": "business_card",
"created_at": "2017-11-28T10:21:33.329+01:00",
"updated_at": "2017-11-28T10:21:33.329+01:00"
},
{
"id": 23430,
"order_id": 15532,
"reference": "UQQV1C",
"custom_references": {},
"state": "draft",
"name": "Broschüre (Rückendrahtheftung)",
"kind": "brochure",
"created_at": "2017-11-28T10:34:11.209+01:00",
"updated_at": "2017-11-28T10:34:11.209+01:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Product object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

order_id: required(string)

Body

Media type: application/json

Type: object

Properties

product: required(object)
Either product_template_id or name have to be given when creating a product.
- custom_references: (object)
  Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the order
- product_template_id: (integer)
  The id of the pre-defined product template on which this product should be based.
- name: (string)
  Name of the product being printed.
- kind: (one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
  Denotes the kind of product being printed.

Example:

{
"product": {
 "name": "Great Business Cards",
 "kind": "business_card",
 "custom_references": {
   "PO": "1234"
 }
}
}

HTTP status code 201

This response is returned if creating a new Product was successful.

Body

Media type: application/json

Type: object

Properties

name: required(string - minLength: 1 - maxLength: 200)
order_id: required(integer)
The id of the order, this product belongs to.
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
state: required(one of draft, prepress, press, postpress, packing, shipping, completed, exception, canceled)
Denotes the state which the product is currently in
kind: required(one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
The kind of product
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 25088,
"order_id": 15532,
"reference": "H9WPQ7",
"custom_references": {
"PO": "123"
},
"state": "draft",
"name": "Visitenkarte",
"kind": "business_card",
"created_at": "2017-12-11T14:39:36.904+01:00",
"updated_at": "2017-12-11T14:39:36.904+01:00"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception

/conception/products/{product_id} get delete patch

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.

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.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string - minLength: 1 - maxLength: 200)
order_id: required(integer)
The id of the order, this product belongs to.
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
custom_references: required(object)
Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
state: required(one of draft, prepress, press, postpress, packing, shipping, completed, exception, canceled)
Denotes the state which the product is currently in
kind: required(one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
The kind of product
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 25088,
"order_id": 15532,
"reference": "H9WPQ7",
"custom_references": {
"PO": "123"
},
"state": "draft",
"name": "Visitenkarte",
"kind": "business_card",
"created_at": "2017-12-11T14:39:36.904+01:00",
"updated_at": "2017-12-11T14:39:36.904+01:00"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete a product in draft state.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Product record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

Body

Media type: application/json

Type: object

Properties

product: required(object)
Either product_template_id or name have to be given when creating a product.
- custom_references: (object)
  Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the order
- product_template_id: (integer)
  The id of the pre-defined product template on which this product should be based.
- name: (string)
  Name of the product being printed.
- kind: (one of brochure, book, business_card, sticker, pad, pages, couvert, custom)
  Denotes the kind of product being printed.

Example:

{
"product": {
 "name": "Great Business Cards",
 "kind": "business_card",
 "custom_references": {
   "PO": "1234"
 }
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/print_data_files get post

The collection of PrintDataFiles

get

Get a list of all PrintDataFile objects.

post

Create a new PrintDataFile object.

Get a list of all PrintDataFile objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: PrintDataFile

print_data_file: required(object)
- printable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- printable_type: required(string)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: required(integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
  "id": 8352,
  "printable_id": 127436,
  "printable_type": "Product",
  "kind": "processed",
  "state": "newly_uploaded",
  "progress": 0,
  "uri": "https://example.com/keyline_print_data_file",
  "preview_path": "https://example.com/keyline_print_data_preview_file",
  "filesize": 3500000,
  "first_page": 1,
  "last_page": 150,
  "created_at": "2019-06-27T07:46:28.523Z",
  "updated_at": "2019-06-27T07:46:28.523Z",
  "print_data_errata": []
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new PrintDataFile object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

Body

Media type: application/json

Type: object

Properties

print_data_file: required(object)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: (integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)

Example:

{
"print_data_file":{
"kind": "processed",
"state": "newly_uploaded",
"uri":"https://example.com/keyline_print_data_file",
"preview_path":"https://example.com/keyline_print_data_preview_file",
"filesize":"3500000",
"first_page":"1",
"last_page":"150",
"process": 1
}
}

HTTP status code 201

This response is returned if creating a new PrintDataFile was successful.

Body

Media type: application/json

Type: object

Properties

print_data_file: required(object)
- printable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- printable_type: required(string)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: required(integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 8352,
"printable_id": 127436,
"printable_type": "Product",
"kind": "processed",
"state": "newly_uploaded",
"progress": 0,
"uri": "https://example.com/keyline_print_data_file",
"preview_path": "https://example.com/keyline_print_data_preview_file",
"filesize": 3500000,
"first_page": 1,
"last_page": 150,
"created_at": "2019-06-27T07:46:28.523Z",
"updated_at": "2019-06-27T07:46:28.523Z",
"print_data_errata": []
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/print_data_files/{print_data_file_id} get patch delete

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.

Get a single PrintDataFile record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
print_data_file_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

print_data_file: required(object)
- printable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- printable_type: required(string)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: required(integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 8352,
"printable_id": 127436,
"printable_type": "Product",
"kind": "processed",
"state": "newly_uploaded",
"progress": 0,
"uri": "https://example.com/keyline_print_data_file",
"preview_path": "https://example.com/keyline_print_data_preview_file",
"filesize": 3500000,
"first_page": 1,
"last_page": 150,
"created_at": "2019-06-27T07:46:28.523Z",
"updated_at": "2019-06-27T07:46:28.523Z",
"print_data_errata": []
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given PrintDataFile record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
print_data_file_id: required(string)

Body

Media type: application/json

Type: object

Properties

print_data_file: required(object)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: (integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)

Example:

{
"print_data_file":{
"kind": "processed",
"state": "newly_uploaded",
"uri":"https://example.com/keyline_print_data_file",
"preview_path":"https://example.com/keyline_print_data_preview_file",
"filesize":"3500000",
"first_page":"1",
"last_page":"150",
"process": 1
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given PrintDataFile record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
print_data_file_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/finishings get post

The collection of Finishings

get

Get a list of all Finishing objects.

post

Create a new Finishing object.

Get a list of all Finishing objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Finishing

finishing: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- stock_finishing_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- finishing_properties: required(array of response.FinishingProperty)
  Items: Finishing Property
  - key: required(string)
  - show_to_customer: required(boolean)
  - kind: required(one of boolean, integer, float, string)
  - unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

[
{
    "id": 157520,
    "stock_finishing_id": 735,
    "kind": "Laminating",
    "created_at": "2019-07-08T10:09:27.247Z",
    "updated_at": "2019-07-08T10:09:27.247Z",
    "finishing_properties": [
        {
            "id": 144216,
            "key": "Both sides",
            "value": false,
            "kind": "boolean",
            "unit": null,
            "show_to_customer": false,
            "created_at": "2019-07-08T10:09:27.251Z",
            "updated_at": "2019-07-08T10:09:27.251Z"
        }
    ]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Finishing object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

Body

Media type: application/json

Type: object

Properties

finishing: required(object)
- stock_finishing_id: required(integer)
  The id of the StockFinishing, this finishing instance is based on. This is only a required attribute when creating new finishing instances via POST requests.

Example:

{
"finishing": {
"stock_finishing_id": 735
}
}

HTTP status code 201

This response is returned if creating a new Finishing was successful.

Body

Media type: application/json

Type: object

Properties

finishing: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- stock_finishing_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- finishing_properties: required(array of response.FinishingProperty)
  Items: Finishing Property
  - key: required(string)
  - show_to_customer: required(boolean)
  - kind: required(one of boolean, integer, float, string)
  - unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 157520,
"stock_finishing_id": 735,
"kind": "Laminating",
"created_at": "2019-07-08T10:09:27.247Z",
"updated_at": "2019-07-08T10:09:27.247Z",
"finishing_properties": [
    {
        "id": 144216,
        "key": "Both sides",
        "value": false,
        "kind": "boolean",
        "unit": null,
        "show_to_customer": false,
        "created_at": "2019-07-08T10:09:27.251Z",
        "updated_at": "2019-07-08T10:09:27.251Z"
    }
]
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/finishings/{finishing_id} get delete

The collection of Finishings.

get

Get a single Finishing record.

delete

Delete the given Finishing record.

Get a single Finishing record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
finishing_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

finishing: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- stock_finishing_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- finishing_properties: required(array of response.FinishingProperty)
  Items: Finishing Property
  - key: required(string)
  - show_to_customer: required(boolean)
  - kind: required(one of boolean, integer, float, string)
  - unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 157520,
"stock_finishing_id": 735,
"kind": "Laminating",
"created_at": "2019-07-08T10:09:27.247Z",
"updated_at": "2019-07-08T10:09:27.247Z",
"finishing_properties": [
    {
        "id": 144216,
        "key": "Both sides",
        "value": false,
        "kind": "boolean",
        "unit": null,
        "show_to_customer": false,
        "created_at": "2019-07-08T10:09:27.251Z",
        "updated_at": "2019-07-08T10:09:27.251Z"
    }
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Finishing record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
finishing_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/finishings/{finishing_id}/finishing_properties get

The collection of FinishingProperties

get

Get a list of all FinishingProperty objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
finishing_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Finishing Property

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
key: required(string)
value: required(one of boolean, integer, float, string)
Depends on the kind defined in the finishing
show_to_customer: required(boolean)
kind: required(one of boolean, integer, float, string)
unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

[
{
    "id": 144217,
    "finishing_id": 157521,
    "kind": "boolean",
    "key": "Both sides",
    "unit": null,
    "raw_data": {
        "value": false
    },
    "created_at": "2019-07-08T10:24:14.183Z",
    "updated_at": "2019-07-08T10:24:14.183Z",
    "key_for_formula": "both_sides",
    "show_to_customer": false
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/finishings/{finishing_id}/finishing_properties/{finishing_property} get patch

The collection of FinishingProperties.

get

Get a single FinishingProperty record.

patch

Update the given FinishingProperty record with provided data.

Get a single FinishingProperty record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
finishing_id: required(string)
finishing_property: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
key: required(string)
value: required(one of boolean, integer, float, string)
Depends on the kind defined in the finishing
show_to_customer: required(boolean)
kind: required(one of boolean, integer, float, string)
unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 144217,
"key": "Both sides",
"value": false,
"kind": "boolean",
"unit": null,
"show_to_customer": false,
"created_at": "2019-07-08T10:24:14.183Z",
"updated_at": "2019-07-08T10:24:14.183Z"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given FinishingProperty record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
finishing_id: required(string)
finishing_property: required(string)

Body

Media type: application/json

Type: object

Properties

finishing_property: required(object)
- value: required(one of boolean, integer, float, string)
  Depends on the kind defined in the finishing
- show_to_customer: required(boolean)

Example:

{
"finishing_property": {
"value": true
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/stock_finishings get

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

get

Get a list of all StockFinishing objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Stock Finishing

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
kind: required(string)
permitted_finishable_type: required(one of product, component, any)
To what kind of object can this finishing be applied? A Product or Component only, or any kind.
properties: required(array of response.FinishingProperty)
Items: Finishing Property
- key: required(string)
- show_to_customer: required(boolean)
- kind: required(one of boolean, integer, float, string)
- unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
common: required(boolean)

Example:

[
{
    "id": 628,
    "kind": "Cellophaning",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T08:54:37.216Z",
    "updated_at": "2018-02-01T10:40:03.001Z",
    "common": true
},
{
    "id": 627,
    "kind": "Chipping",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:50:57.734Z",
    "updated_at": "2018-02-01T07:50:57.734Z",
    "common": true
},
{
    "id": 634,
    "kind": "Collecting",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:39:32.100Z",
    "updated_at": "2018-02-01T10:39:32.100Z",
    "common": true
},
{
    "id": 617,
    "kind": "Concealing",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:34:39.138Z",
    "updated_at": "2018-02-01T07:34:53.163Z",
    "common": true
},
{
    "id": 611,
    "kind": "Corner rounding",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of corners",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:27:29.312Z",
    "updated_at": "2018-02-01T07:28:05.249Z",
    "common": true
},
{
    "id": 623,
    "kind": "Creasing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of creasing rules",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:46:25.684Z",
    "updated_at": "2018-02-01T07:48:30.130Z",
    "common": true
},
{
    "id": 610,
    "kind": "Dispersion coating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:26:30.721Z",
    "updated_at": "2018-02-01T07:30:23.004Z",
    "common": true
},
{
    "id": 532,
    "kind": "Drilling",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of holes",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-15T11:46:57.146Z",
    "updated_at": "2018-02-01T07:18:24.983Z",
    "common": true
},
{
    "id": 607,
    "kind": "Embossing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per embossing stamp",
            "kind": "float",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:17:13.441Z",
    "updated_at": "2018-02-01T07:18:04.204Z",
    "common": true
},
{
    "id": 619,
    "kind": "Eyelet binding",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of eyelets",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:38:34.090Z",
    "updated_at": "2018-02-01T07:39:01.151Z",
    "common": true
},
{
    "id": 608,
    "kind": "Foil embossing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per embossing stamp",
            "kind": "float",
            "show_to_customer": false
        },
        {
            "key": "Embossing area",
            "kind": "float",
            "unit": "sqmillimeter",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:18:42.585Z",
    "updated_at": "2018-02-01T07:20:04.464Z",
    "common": true
},
{
    "id": 614,
    "kind": "Glueing",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:31:46.318Z",
    "updated_at": "2018-02-01T07:32:00.425Z",
    "common": true
},
{
    "id": 609,
    "kind": "Laminating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:20:37.828Z",
    "updated_at": "2018-02-01T07:30:42.497Z",
    "common": true
},
{
    "id": 632,
    "kind": "Numbering",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:38:42.281Z",
    "updated_at": "2018-02-01T10:38:49.758Z",
    "common": true
},
{
    "id": 613,
    "kind": "Perfect binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:31:06.078Z",
    "updated_at": "2018-02-01T07:31:27.336Z",
    "common": true
},
{
    "id": 533,
    "kind": "Perforating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of perforation lines",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-15T11:59:34.318Z",
    "updated_at": "2018-02-01T07:48:58.589Z",
    "common": true
},
{
    "id": 620,
    "kind": "Punching",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per punch form",
            "kind": "float",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:39:57.872Z",
    "updated_at": "2018-02-01T07:40:38.822Z",
    "common": true
},
{
    "id": 615,
    "kind": "Punch numbering",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:33:24.399Z",
    "updated_at": "2018-02-01T07:33:38.735Z",
    "common": true
},
{
    "id": 621,
    "kind": "Saddle stitching",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of stitchings",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:40:58.742Z",
    "updated_at": "2018-02-01T15:46:09.246Z",
    "common": true
},
{
    "id": 612,
    "kind": "Shrink wrapping",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:28:27.780Z",
    "updated_at": "2018-02-01T08:55:05.120Z",
    "common": true
},
{
    "id": 624,
    "kind": "Spiral binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:49:37.327Z",
    "updated_at": "2018-02-01T07:49:46.892Z",
    "common": true
},
{
    "id": 625,
    "kind": "Thermo binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:50:34.325Z",
    "updated_at": "2018-02-01T07:50:34.325Z",
    "common": true
},
{
    "id": 618,
    "kind": "Thread stitching",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:37:45.372Z",
    "updated_at": "2018-02-01T07:37:55.546Z",
    "common": true
},
{
    "id": 622,
    "kind": "UV coating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:45:33.649Z",
    "updated_at": "2018-02-01T07:45:44.197Z",
    "common": true
},
{
    "id": 543,
    "kind": "Varnishing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-24T10:13:11.424Z",
    "updated_at": "2018-02-01T10:37:13.158Z",
    "common": true
},
{
    "id": 630,
    "kind": "Wire-o binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:37:21.870Z",
    "updated_at": "2018-02-01T10:37:35.640Z",
    "common": true
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components get post

The collection of Components

get

Get a list of all Component objects.

post

Create a new Component object.

Get a list of all Component objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Component

component: required(object)
- name: required(string - minLength: 1 - maxLength: 200)
- number_of_pages: required(integer - minimum: 2)
- closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
- opened_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
- front_colors: (array of string)
  Lists the colors of the front of the component
- back_colors: (array of string)
  Lists the colors of the back of the component
- page_arrangement: (one of standalone, crossover, parallel)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 107633,
"name": "Umschlag",
"closed_dimensions": [
  210,
  297
],
"page_arrangement": "standalone",
"number_of_pages": 2,
"front_colors": [
  "CMYK/Black"
],
"back_colors": [],
"created_at": "2018-12-17T06:47:15.175Z",
"updated_at": "2019-03-20T11:49:51.349Z",
"opened_dimensions": [
  210,
  297
]
},
{
"id": 107634,
"name": "Innenteil",
"closed_dimensions": [
  148,
  210
],
"page_arrangement": "crossover",
"number_of_pages": 20,
"front_colors": [
  "CMYK/Cyan",
  "CMYK/Magenta",
  "CMYK/Yellow",
  "CMYK/Black"
],
"back_colors": [
  "CMYK/Cyan",
  "CMYK/Magenta",
  "CMYK/Yellow",
  "CMYK/Black"
],
"created_at": "2018-12-17T06:47:19.521Z",
"updated_at": "2018-12-17T10:16:01.765Z",
"opened_dimensions": [
  296,
  210
]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Component object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

Body

Media type: application/json

Type: object

Properties

component: required(object)
- name: required(string - maxLength: 200)
- closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
  An array, that must always be comprised of two integers, that give the components closed_dimensions in mm. First element is closed dimensions width, second element is height
- page_arrangement: (one of standalone, crossover, parallel)
- front_colors: (array of string)
  Optionally specify the colors of the front of the component, in the form of $color_family/$color_name, where $color_family is one of CMYK, HKS, Pantone, custom.
- back_colors: (array of string)
  Optionally specify the colors of the front of the component, in the form of $color_family/$color_name, where $color_family is one of CMYK, HKS, Pantone, custom.

Example:

{
"component": {
"name": "Einleger",
"closed_dimensions": [
  210,
  297
],
"page_arrangement": "standalone",
"number_of_pages": 2,
"front_colors": [
  "CMYK/Black"
],
"back_colors": []
}
}

HTTP status code 201

This response is returned if creating a new Component was successful.

Body

Media type: application/json

Type: object

Properties

component: required(object)
- name: required(string - minLength: 1 - maxLength: 200)
- number_of_pages: required(integer - minimum: 2)
- closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
- opened_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
- front_colors: (array of string)
  Lists the colors of the front of the component
- back_colors: (array of string)
  Lists the colors of the back of the component
- page_arrangement: (one of standalone, crossover, parallel)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 107633,
"name": "Umschlag",
"closed_dimensions": [
210,
297
],
"page_arrangement": "standalone",
"number_of_pages": 2,
"front_colors": [
"CMYK/Black"
],
"back_colors": [],
"created_at": "2018-12-17T06:47:15.175Z",
"updated_at": "2019-03-20T11:49:51.349Z",
"opened_dimensions": [
210,
297
]
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id} get patch delete

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.

Get a single Component record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

component: required(object)
- name: required(string - minLength: 1 - maxLength: 200)
- number_of_pages: required(integer - minimum: 2)
- closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
- opened_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
- front_colors: (array of string)
  Lists the colors of the front of the component
- back_colors: (array of string)
  Lists the colors of the back of the component
- page_arrangement: (one of standalone, crossover, parallel)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 107633,
"name": "Umschlag",
"closed_dimensions": [
210,
297
],
"page_arrangement": "standalone",
"number_of_pages": 2,
"front_colors": [
"CMYK/Black"
],
"back_colors": [],
"created_at": "2018-12-17T06:47:15.175Z",
"updated_at": "2019-03-20T11:49:51.349Z",
"opened_dimensions": [
210,
297
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Component record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

Body

Media type: application/json

Type: object

Properties

component: required(object)
- name: required(string - maxLength: 200)
- closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
  An array, that must always be comprised of two integers, that give the components closed_dimensions in mm. First element is closed dimensions width, second element is height
- page_arrangement: (one of standalone, crossover, parallel)
- front_colors: (array of string)
  Optionally specify the colors of the front of the component, in the form of $color_family/$color_name, where $color_family is one of CMYK, HKS, Pantone, custom.
- back_colors: (array of string)
  Optionally specify the colors of the front of the component, in the form of $color_family/$color_name, where $color_family is one of CMYK, HKS, Pantone, custom.

Example:

{
"component": {
"name": "Einleger",
"closed_dimensions": [
  210,
  297
],
"page_arrangement": "standalone",
"number_of_pages": 2,
"front_colors": [
  "CMYK/Black"
],
"back_colors": []
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Component record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/finishings get post

The collection of Finishings

get

Get a list of all Finishing objects.

post

Create a new Finishing object.

Get a list of all Finishing objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Finishing

finishing: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- stock_finishing_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- finishing_properties: required(array of response.FinishingProperty)
  Items: Finishing Property
  - key: required(string)
  - show_to_customer: required(boolean)
  - kind: required(one of boolean, integer, float, string)
  - unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

[
{
    "id": 157520,
    "stock_finishing_id": 735,
    "kind": "Laminating",
    "created_at": "2019-07-08T10:09:27.247Z",
    "updated_at": "2019-07-08T10:09:27.247Z",
    "finishing_properties": [
        {
            "id": 144216,
            "key": "Both sides",
            "value": false,
            "kind": "boolean",
            "unit": null,
            "show_to_customer": false,
            "created_at": "2019-07-08T10:09:27.251Z",
            "updated_at": "2019-07-08T10:09:27.251Z"
        }
    ]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Finishing object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

Body

Media type: application/json

Type: object

Properties

finishing: required(object)
- stock_finishing_id: required(integer)
  The id of the StockFinishing, this finishing instance is based on. This is only a required attribute when creating new finishing instances via POST requests.

Example:

{
"finishing": {
"stock_finishing_id": 735
}
}

HTTP status code 201

This response is returned if creating a new Finishing was successful.

Body

Media type: application/json

Type: object

Properties

finishing: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- stock_finishing_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- finishing_properties: required(array of response.FinishingProperty)
  Items: Finishing Property
  - key: required(string)
  - show_to_customer: required(boolean)
  - kind: required(one of boolean, integer, float, string)
  - unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 157520,
"stock_finishing_id": 735,
"kind": "Laminating",
"created_at": "2019-07-08T10:09:27.247Z",
"updated_at": "2019-07-08T10:09:27.247Z",
"finishing_properties": [
    {
        "id": 144216,
        "key": "Both sides",
        "value": false,
        "kind": "boolean",
        "unit": null,
        "show_to_customer": false,
        "created_at": "2019-07-08T10:09:27.251Z",
        "updated_at": "2019-07-08T10:09:27.251Z"
    }
]
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/finishings/{finishing_id} get delete

The collection of Finishings.

get

Get a single Finishing record.

delete

Delete the given Finishing record.

Get a single Finishing record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
finishing_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

finishing: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- stock_finishing_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- finishing_properties: required(array of response.FinishingProperty)
  Items: Finishing Property
  - key: required(string)
  - show_to_customer: required(boolean)
  - kind: required(one of boolean, integer, float, string)
  - unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 157520,
"stock_finishing_id": 735,
"kind": "Laminating",
"created_at": "2019-07-08T10:09:27.247Z",
"updated_at": "2019-07-08T10:09:27.247Z",
"finishing_properties": [
    {
        "id": 144216,
        "key": "Both sides",
        "value": false,
        "kind": "boolean",
        "unit": null,
        "show_to_customer": false,
        "created_at": "2019-07-08T10:09:27.251Z",
        "updated_at": "2019-07-08T10:09:27.251Z"
    }
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Finishing record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
finishing_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/finishings/{finishing_id}/finishing_properties get

The collection of FinishingProperties

get

Get a list of all FinishingProperty objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
finishing_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Finishing Property

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
key: required(string)
value: required(one of boolean, integer, float, string)
Depends on the kind defined in the finishing
show_to_customer: required(boolean)
kind: required(one of boolean, integer, float, string)
unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

[
{
    "id": 144217,
    "finishing_id": 157521,
    "kind": "boolean",
    "key": "Both sides",
    "unit": null,
    "raw_data": {
        "value": false
    },
    "created_at": "2019-07-08T10:24:14.183Z",
    "updated_at": "2019-07-08T10:24:14.183Z",
    "key_for_formula": "both_sides",
    "show_to_customer": false
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/finishings/{finishing_id}/finishing_properties/{finishing_property} get patch

The collection of FinishingProperties.

get

Get a single FinishingProperty record.

patch

Update the given FinishingProperty record with provided data.

Get a single FinishingProperty record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
finishing_id: required(string)
finishing_property: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
key: required(string)
value: required(one of boolean, integer, float, string)
Depends on the kind defined in the finishing
show_to_customer: required(boolean)
kind: required(one of boolean, integer, float, string)
unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 144217,
"key": "Both sides",
"value": false,
"kind": "boolean",
"unit": null,
"show_to_customer": false,
"created_at": "2019-07-08T10:24:14.183Z",
"updated_at": "2019-07-08T10:24:14.183Z"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given FinishingProperty record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
finishing_id: required(string)
finishing_property: required(string)

Body

Media type: application/json

Type: object

Properties

finishing_property: required(object)
- value: required(one of boolean, integer, float, string)
  Depends on the kind defined in the finishing
- show_to_customer: required(boolean)

Example:

{
"finishing_property": {
"value": true
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/imposings get

The collection of Imposings

get

Get a list of all Imposing objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Imposing

imposing: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- production_path_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- printing_technique: required(one of none, digital, offset, offset_uv, digital_web, offset_web, inkjet, inkjet_web, pad, letterpress)
- maximum_number_of_mups_per_sheet: required(integer)
- imposing_mode: required(one of single_mup, multi_mup, perfecting, multi_mup_turn_or_tumble, multi_mup_turn, multi_mup_tumble)
- default_margin: required(number)
- default_stock_folding_pattern_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- auto_signature_generation: required(boolean)
- allow_printing_on_gripper: required(boolean)
- disable_folding: required(boolean)
- mup_orientation: required(string)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

[
{
    "id": 251994,
    "production_path_id": 194930,
    "printing_technique": "offset",
    "maximum_number_of_mups_per_sheet": null,
    "imposing_mode": "multi_mup",
    "default_margin": null,
    "default_stock_folding_pattern_id": null,
    "auto_signature_generation": true,
    "allow_printing_on_gripper": false,
    "disable_folding": false,
    "mup_orientation": "maximize_substrate_utilization",
    "created_at": "2019-07-08T10:09:27.301Z",
    "updated_at": "2019-07-08T10:09:27.301Z"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/imposings/{imposing_id} get patch

The collection of Imposings.

get

Get a single Imposing record.

patch

Update the given Imposing record with provided data.

Get a single Imposing record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
imposing_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

imposing: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- production_path_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- printing_technique: required(one of none, digital, offset, offset_uv, digital_web, offset_web, inkjet, inkjet_web, pad, letterpress)
- maximum_number_of_mups_per_sheet: required(integer)
- imposing_mode: required(one of single_mup, multi_mup, perfecting, multi_mup_turn_or_tumble, multi_mup_turn, multi_mup_tumble)
- default_margin: required(number)
- default_stock_folding_pattern_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- auto_signature_generation: required(boolean)
- allow_printing_on_gripper: required(boolean)
- disable_folding: required(boolean)
- mup_orientation: required(string)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 251994,
"production_path_id": 194930,
"printing_technique": "offset",
"maximum_number_of_mups_per_sheet": null,
"imposing_mode": "multi_mup",
"default_margin": null,
"default_stock_folding_pattern_id": null,
"auto_signature_generation": true,
"allow_printing_on_gripper": false,
"disable_folding": false,
"mup_orientation": "maximize_substrate_utilization",
"created_at": "2019-07-08T10:09:27.301Z",
"updated_at": "2019-07-08T10:09:27.301Z"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Imposing record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
imposing_id: required(string)

Body

Media type: application/json

Type: object

Properties

imposing: required(object)
- printing_technique: required(one of none, digital, offset, offset_uv, digital_web, offset_web, inkjet, inkjet_web, pad, letterpress)
- maximum_number_of_mups_per_sheet: required(integer)
- imposing_mode: required(one of single_mup, multi_mup, perfecting, multi_mup_turn_or_tumble, multi_mup_turn, multi_mup_tumble)
- default_margin: required(number)
- default_stock_folding_pattern_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- auto_signature_generation: required(boolean)
- allow_printing_on_gripper: required(boolean)
- disable_folding: required(boolean)
- mup_orientation: required(string)

Example:

{
"imposing": {
"printing_technique": "digital",
"default_margin": 5.0,
"allow_printing_on_gripper": true
}
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
"id": 251994,
"production_path_id": 194930,
"printing_technique": "offset",
"maximum_number_of_mups_per_sheet": null,
"imposing_mode": "multi_mup",
"default_margin": null,
"default_stock_folding_pattern_id": null,
"auto_signature_generation": true,
"allow_printing_on_gripper": false,
"disable_folding": false,
"mup_orientation": "maximize_substrate_utilization",
"created_at": "2019-07-08T10:09:27.301Z",
"updated_at": "2019-07-08T10:09:27.301Z"
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/imposings/{imposing_id}/substrate get post patch delete

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.

Get the Substrate record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
imposing_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
stock_substrate_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
imposing_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
name: required(string)
dimensions: required(array of integer - minItems: 2 - maxItems: 2)
The dimensions of the paper in mm, where the first element of the array is the width and the second being height.
precut_dimensions: (array of integer - minItems: 2 - maxItems: 2)
The precut dimensions of the paper in mm, where the first element of the array is the width and the second being height.
grain: required(one of long, short)
actual_grain: (one of long, short)
grammage: required(integer - minimum: 1)
Grammage of the paper (in gsm)
color_saturation: required(number - minimum: 0)
thickness: required(integer)
kind: required(string)
Describes the kind of substrate that is represented by this object as a string.
form: required(one of sheet, roll, envelope, piece)
category: required(string)
Describes the category of substrate that is represented by this object as a string.
coated: required(boolean)
environmental_certification: required(one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
texture: required(string)
A string describing the texture of the substrate. These are usually not comparable across suppliers.
color: required(string)
A string describing the color. These are usually not comparable across suppliers.
automatically_selected: required(boolean)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 247863,
"stock_substrate_id": 96759,
"imposing_id": 254842,
"name": "Amber Graphic",
"dimensions": [
    320,
    450
],
"precut_dimensions": null,
"grain": "short",
"actual_grain": "short",
"grammage": 120,
"color_saturation": null,
"thickness": 145,
"kind": "paper",
"form": "sheet",
"category": "wood-free",
"coated": false,
"environmental_certification": null,
"texture": null,
"color": "white",
"automatically_selected": false,
"created_at": "2019-07-09T05:33:02.390Z",
"updated_at": "2019-07-09T05:33:02.390Z"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Substrate record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
imposing_id: required(string)

Body

Media type: application/json

Type: object

Properties

service: required(object)
- stock_substrate_id: required(integer)
  The id of the StockSubstrate, this substrate instance is based on. This is only a required attribute when creating new substrate instances via POST requests.
- precut_dimensions: (array of integer - minItems: 2 - maxItems: 2)
  The precut dimensions for this paper in mm, where the first element of the array is the width and the second being height.

Example:

{
"substrate": {
"stock_substrate_id": 96759
}
}

HTTP status code 201

This response is returned if creating a new Substrate was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
stock_substrate_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
imposing_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
name: required(string)
dimensions: required(array of integer - minItems: 2 - maxItems: 2)
The dimensions of the paper in mm, where the first element of the array is the width and the second being height.
precut_dimensions: (array of integer - minItems: 2 - maxItems: 2)
The precut dimensions of the paper in mm, where the first element of the array is the width and the second being height.
grain: required(one of long, short)
actual_grain: (one of long, short)
grammage: required(integer - minimum: 1)
Grammage of the paper (in gsm)
color_saturation: required(number - minimum: 0)
thickness: required(integer)
kind: required(string)
Describes the kind of substrate that is represented by this object as a string.
form: required(one of sheet, roll, envelope, piece)
category: required(string)
Describes the category of substrate that is represented by this object as a string.
coated: required(boolean)
environmental_certification: required(one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
texture: required(string)
A string describing the texture of the substrate. These are usually not comparable across suppliers.
color: required(string)
A string describing the color. These are usually not comparable across suppliers.
automatically_selected: required(boolean)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 247863,
"stock_substrate_id": 96759,
"imposing_id": 254842,
"name": "Amber Graphic",
"dimensions": [
    320,
    450
],
"precut_dimensions": null,
"grain": "short",
"actual_grain": "short",
"grammage": 120,
"color_saturation": null,
"thickness": 145,
"kind": "paper",
"form": "sheet",
"category": "wood-free",
"coated": false,
"environmental_certification": null,
"texture": null,
"color": "white",
"automatically_selected": false,
"created_at": "2019-07-09T05:33:02.390Z",
"updated_at": "2019-07-09T05:33:02.390Z"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Substrate record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
imposing_id: required(string)

Body

Media type: application/json

Type: object

Properties

service: required(object)
- stock_substrate_id: required(integer)
  The id of the StockSubstrate, this substrate instance is based on. This is only a required attribute when creating new substrate instances via POST requests.
- precut_dimensions: (array of integer - minItems: 2 - maxItems: 2)
  The precut dimensions for this paper in mm, where the first element of the array is the width and the second being height.

Example:

{
"substrate": {
"stock_substrate_id": 96759
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Substrate record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
imposing_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/print_data_files get post

The collection of PrintDataFiles

get

Get a list of all PrintDataFile objects.

post

Create a new PrintDataFile object.

Get a list of all PrintDataFile objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: PrintDataFile

print_data_file: required(object)
- printable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- printable_type: required(string)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: required(integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
  "id": 8352,
  "printable_id": 127436,
  "printable_type": "Product",
  "kind": "processed",
  "state": "newly_uploaded",
  "progress": 0,
  "uri": "https://example.com/keyline_print_data_file",
  "preview_path": "https://example.com/keyline_print_data_preview_file",
  "filesize": 3500000,
  "first_page": 1,
  "last_page": 150,
  "created_at": "2019-06-27T07:46:28.523Z",
  "updated_at": "2019-06-27T07:46:28.523Z",
  "print_data_errata": []
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new PrintDataFile object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

Body

Media type: application/json

Type: object

Properties

print_data_file: required(object)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: (integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)

Example:

{
"print_data_file":{
"kind": "processed",
"state": "newly_uploaded",
"uri":"https://example.com/keyline_print_data_file",
"preview_path":"https://example.com/keyline_print_data_preview_file",
"filesize":"3500000",
"first_page":"1",
"last_page":"150",
"process": 1
}
}

HTTP status code 201

This response is returned if creating a new PrintDataFile was successful.

Body

Media type: application/json

Type: object

Properties

print_data_file: required(object)
- printable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- printable_type: required(string)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: required(integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 8352,
"printable_id": 127436,
"printable_type": "Product",
"kind": "processed",
"state": "newly_uploaded",
"progress": 0,
"uri": "https://example.com/keyline_print_data_file",
"preview_path": "https://example.com/keyline_print_data_preview_file",
"filesize": 3500000,
"first_page": 1,
"last_page": 150,
"created_at": "2019-06-27T07:46:28.523Z",
"updated_at": "2019-06-27T07:46:28.523Z",
"print_data_errata": []
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/print_data_files/{print_data_file_id} get patch delete

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.

Get a single PrintDataFile record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
print_data_file_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

print_data_file: required(object)
- printable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- printable_type: required(string)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: required(integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 8352,
"printable_id": 127436,
"printable_type": "Product",
"kind": "processed",
"state": "newly_uploaded",
"progress": 0,
"uri": "https://example.com/keyline_print_data_file",
"preview_path": "https://example.com/keyline_print_data_preview_file",
"filesize": 3500000,
"first_page": 1,
"last_page": 150,
"created_at": "2019-06-27T07:46:28.523Z",
"updated_at": "2019-06-27T07:46:28.523Z",
"print_data_errata": []
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given PrintDataFile record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
print_data_file_id: required(string)

Body

Media type: application/json

Type: object

Properties

print_data_file: required(object)
- uri: required(string)
  The full URI of this print data file, including the protocol
- preview_path: (string)
  The full URI of this print data file, including the protocol in a preview size
- filesize: (integer)
  The size of this print data file in bytes
- last_page: (integer)
  The last page inside the print data file's PDF
- first_page: (integer)
  The first page inside the print data file's PDF
- kind: required(one of original, processed, imposed)
- state: required(one of newly_uploaded, processing, processed)
- progress: (integer - minimum: 0 - maximum: 1)
  Indicates the progress of a file to be processed (e.g. 50% – 0.50)

Example:

{
"print_data_file":{
"kind": "processed",
"state": "newly_uploaded",
"uri":"https://example.com/keyline_print_data_file",
"preview_path":"https://example.com/keyline_print_data_preview_file",
"filesize":"3500000",
"first_page":"1",
"last_page":"150",
"process": 1
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given PrintDataFile record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)
print_data_file_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/stock_finishings get

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

get

Get a list of all StockFinishing objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Stock Finishing

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
kind: required(string)
permitted_finishable_type: required(one of product, component, any)
To what kind of object can this finishing be applied? A Product or Component only, or any kind.
properties: required(array of response.FinishingProperty)
Items: Finishing Property
- key: required(string)
- show_to_customer: required(boolean)
- kind: required(one of boolean, integer, float, string)
- unit: required(one of pdf, piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
common: required(boolean)

Example:

[
{
    "id": 628,
    "kind": "Cellophaning",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T08:54:37.216Z",
    "updated_at": "2018-02-01T10:40:03.001Z",
    "common": true
},
{
    "id": 627,
    "kind": "Chipping",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:50:57.734Z",
    "updated_at": "2018-02-01T07:50:57.734Z",
    "common": true
},
{
    "id": 634,
    "kind": "Collecting",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:39:32.100Z",
    "updated_at": "2018-02-01T10:39:32.100Z",
    "common": true
},
{
    "id": 617,
    "kind": "Concealing",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:34:39.138Z",
    "updated_at": "2018-02-01T07:34:53.163Z",
    "common": true
},
{
    "id": 611,
    "kind": "Corner rounding",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of corners",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:27:29.312Z",
    "updated_at": "2018-02-01T07:28:05.249Z",
    "common": true
},
{
    "id": 623,
    "kind": "Creasing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of creasing rules",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:46:25.684Z",
    "updated_at": "2018-02-01T07:48:30.130Z",
    "common": true
},
{
    "id": 610,
    "kind": "Dispersion coating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:26:30.721Z",
    "updated_at": "2018-02-01T07:30:23.004Z",
    "common": true
},
{
    "id": 532,
    "kind": "Drilling",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of holes",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-15T11:46:57.146Z",
    "updated_at": "2018-02-01T07:18:24.983Z",
    "common": true
},
{
    "id": 607,
    "kind": "Embossing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per embossing stamp",
            "kind": "float",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:17:13.441Z",
    "updated_at": "2018-02-01T07:18:04.204Z",
    "common": true
},
{
    "id": 619,
    "kind": "Eyelet binding",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of eyelets",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:38:34.090Z",
    "updated_at": "2018-02-01T07:39:01.151Z",
    "common": true
},
{
    "id": 608,
    "kind": "Foil embossing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per embossing stamp",
            "kind": "float",
            "show_to_customer": false
        },
        {
            "key": "Embossing area",
            "kind": "float",
            "unit": "sqmillimeter",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:18:42.585Z",
    "updated_at": "2018-02-01T07:20:04.464Z",
    "common": true
},
{
    "id": 614,
    "kind": "Glueing",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:31:46.318Z",
    "updated_at": "2018-02-01T07:32:00.425Z",
    "common": true
},
{
    "id": 609,
    "kind": "Laminating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:20:37.828Z",
    "updated_at": "2018-02-01T07:30:42.497Z",
    "common": true
},
{
    "id": 632,
    "kind": "Numbering",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:38:42.281Z",
    "updated_at": "2018-02-01T10:38:49.758Z",
    "common": true
},
{
    "id": 613,
    "kind": "Perfect binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:31:06.078Z",
    "updated_at": "2018-02-01T07:31:27.336Z",
    "common": true
},
{
    "id": 533,
    "kind": "Perforating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of perforation lines",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-15T11:59:34.318Z",
    "updated_at": "2018-02-01T07:48:58.589Z",
    "common": true
},
{
    "id": 620,
    "kind": "Punching",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Costs per punch form",
            "kind": "float",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:39:57.872Z",
    "updated_at": "2018-02-01T07:40:38.822Z",
    "common": true
},
{
    "id": 615,
    "kind": "Punch numbering",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:33:24.399Z",
    "updated_at": "2018-02-01T07:33:38.735Z",
    "common": true
},
{
    "id": 621,
    "kind": "Saddle stitching",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Number of stitchings",
            "kind": "integer",
            "unit": "piece",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:40:58.742Z",
    "updated_at": "2018-02-01T15:46:09.246Z",
    "common": true
},
{
    "id": 612,
    "kind": "Shrink wrapping",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:28:27.780Z",
    "updated_at": "2018-02-01T08:55:05.120Z",
    "common": true
},
{
    "id": 624,
    "kind": "Spiral binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:49:37.327Z",
    "updated_at": "2018-02-01T07:49:46.892Z",
    "common": true
},
{
    "id": 625,
    "kind": "Thermo binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:50:34.325Z",
    "updated_at": "2018-02-01T07:50:34.325Z",
    "common": true
},
{
    "id": 618,
    "kind": "Thread stitching",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T07:37:45.372Z",
    "updated_at": "2018-02-01T07:37:55.546Z",
    "common": true
},
{
    "id": 622,
    "kind": "UV coating",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2018-02-01T07:45:33.649Z",
    "updated_at": "2018-02-01T07:45:44.197Z",
    "common": true
},
{
    "id": 543,
    "kind": "Varnishing",
    "permitted_finishable_type": "any",
    "properties": [
        {
            "key": "Both sides",
            "kind": "boolean",
            "show_to_customer": false
        }
    ],
    "created_at": "2017-11-24T10:13:11.424Z",
    "updated_at": "2018-02-01T10:37:13.158Z",
    "common": true
},
{
    "id": 630,
    "kind": "Wire-o binding",
    "permitted_finishable_type": "any",
    "properties": [],
    "created_at": "2018-02-01T10:37:21.870Z",
    "updated_at": "2018-02-01T10:37:35.640Z",
    "common": true
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/components/{component_id}/desired_substrate_properties get patch

The DesiredSubstrateProperties record associated with the parent record.

get

Get the DesiredSubstrateProperty record.

patch

Update the given DesiredSubstrateProperty record with provided data.

Get the DesiredSubstrateProperty record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
name: required(string)
grain: required(one of long, short)
category: required(string)
Describes the category of substrate that is represented by this object as a string.
grammage: required(integer - minimum: 1)
Grammage of the paper (in gsm)
environmental_certification: required(one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
dimensions: required(array of integer - minItems: 2 - maxItems: 2)
The dimensions of the paper in mm, where the first element of the array is the width and the second being height.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 306806,
"component_id": 311748,
"name": "Multiart Silk",
"dimensions": [1000, 700],
"grain": null,
"grammage": 90,
"category": null,
"color": null,
"environmental_certification": null,
"created_at": "2020-06-22T12:10:45.736Z",
"updated_at": "2020-06-25T09:38:00.746Z"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given DesiredSubstrateProperty record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
component_id: required(string)

Body

Media type: application/json

Type: object

Properties

grain: required(one of long, short)
category: required(string)
Describes the category of substrate that is represented by this object as a string.
grammage: required(integer - minimum: 1)
Grammage of the paper (in gsm)
environmental_certification: required(one of PEFC 70%, PEFC 75%, PEFC 80%, PEFC 94%, PEFC 100%, FSC 30%, FSC 50%, FSC 70%, FSC 80%, FSC 100%, FSC Mix Credit, FSC Mix 30%, FSC Mix 50%, FSC Mix 70%, FSC Mix 80%, FSC Recycled Credit, FSC Recycled 30%, FSC Recycled 50%, FSC Recycled 60%, FSC Recycled 70%, FSC Recycled 75%, FSC Recycled 80%, FSC Recycled 85%, FSC Recycled 95%, FSC Recycled 100%)
dimensions: required(array of integer - minItems: 2 - maxItems: 2)
The dimensions of the paper in mm, where the first element of the array is the width and the second being height.

Example:

{
"desired_substrate_properties": {
"name": "Multiart Silk",
"dimensions": [1000, 700],
"grammage": 90
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/production_paths get post

The collection of ProductionPaths

get

Get a list of all ProductionPath objects.

post

Create a new ProductionPath object.

Get a list of all ProductionPath objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: ProductionPath

circulation: required(integer - minimum: 1)
The product's combined circulation, that is the sum of all variants' circulations. This also means, that if you want to change this value, you need to adjust the circulations for the respective variants.
state: required(one of done, pending, preparing, imposing, planning, calculating, error)
Describes the state of this production path. This usually done and only changes when Keyline calculates the conception of the product.
conception_mode: required(one of concurrent, manual)
Describes the conception mode of this production path.
selected_for_production: required(boolean)
Denotes if this production path has been selected for the actual production of the product.
show_in_offer: required(boolean)
Denotes, if this production path with all it's details should be added to the offer that's sent to the customer.
production_costs: required(integer)
costs_per_unit: required(number)
costs_per_thousand: required(integer)
discounted_total: required(integer)
outsourced: required(boolean)
If set to true, no production planning will happen for this production path.
keep_total: required(boolean)
If set to true, then the value for total is fixed and the margin is adjusted. If set to false, then margin is fixed and the value of total will be adjusted, based on the production_costs and margin.
sub_total: required(integer)
Denotes the sub_total price for this production path, which is the total minus any service costs, and must be given in the smallest currency unit of the printery.
total: required(integer)
Denotes the total price for this production path.
discount: required(number - minimum: 0 - maximum: 1)
Denotes the discount, given as a percentage, that should be applied to this production paths costs in order to calculate the total price of the printed goods. The discount is not applied to services associated with the current product.
margin: required(number - minimum: 0)
Denotes the margin that should be applied to the costs of this production path's printed goods.
product_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 34207,
"product_id": 23426,
"state": "done",
"circulation": 300,
"selected_for_production": false,
"show_in_offer": true,
"production_costs": 186335,
"costs_per_unit": "633.54",
"costs_per_thousand": 633540,
"total": 190062,
"margin": "0.02",
"discount": "0.0",
"discounted_total": 190062,
"outsourced": false,
"keep_total": false,
"created_at": "2017-12-12T10:06:04.652+01:00",
"updated_at": "2017-12-12T10:07:38.851+01:00"
},
{
"id": 32069,
"product_id": 23426,
"state": "done",
"circulation": 3000,
"selected_for_production": true,
"show_in_offer": true,
"production_costs": 187164,
"costs_per_unit": "63.636",
"costs_per_thousand": 63636,
"total": 190908,
"margin": "0.02",
"discount": "0.0",
"discounted_total": 190908,
"outsourced": false,
"keep_total": false,
"created_at": "2017-11-28T10:21:33.373+01:00",
"updated_at": "2017-12-11T16:38:22.812+01:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new ProductionPath object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

Body

Media type: application/json

Type: object

Properties

production_path: required(object)
- show_in_offer: (boolean)
  Denotes, if this production path with all it's details should be added to the offer that's sent to the customer.
- outsourced: (boolean)
  If set to true, no production planning will happen for this production path.
- keep_total: (boolean)
  If set to true, then the value for total is fixed and the margin is adjusted. If set to false, then margin is fixed and
- sub_total: (integer)
  Denotes the sub_total price for this production path, which is the total minus any service costs, and must be given in the smallest currency unit of the printery.
- discount: (number - minimum: 0 - maximum: 1)
  Denotes the discount, given as a percentage, that should be applied to this production paths costs in order to calculate the total price of the printed goods. The discount is not applied to services associated with the current product.
- margin: (number - minimum: 0)
  Denotes the margin that should be applied to the costs of this production path's printed goods.
- conception_mode: (one of concurrent, manual)
  Describes the conception mode of this production path.

Example:

{
"production_path": {
"show_in_offer": false
}
}

HTTP status code 201

This response is returned if creating a new ProductionPath was successful.

Body

Media type: application/json

Type: object

Properties

circulation: required(integer - minimum: 1)
The product's combined circulation, that is the sum of all variants' circulations. This also means, that if you want to change this value, you need to adjust the circulations for the respective variants.
state: required(one of done, pending, preparing, imposing, planning, calculating, error)
Describes the state of this production path. This usually done and only changes when Keyline calculates the conception of the product.
conception_mode: required(one of concurrent, manual)
Describes the conception mode of this production path.
selected_for_production: required(boolean)
Denotes if this production path has been selected for the actual production of the product.
show_in_offer: required(boolean)
Denotes, if this production path with all it's details should be added to the offer that's sent to the customer.
production_costs: required(integer)
costs_per_unit: required(number)
costs_per_thousand: required(integer)
discounted_total: required(integer)
outsourced: required(boolean)
If set to true, no production planning will happen for this production path.
keep_total: required(boolean)
If set to true, then the value for total is fixed and the margin is adjusted. If set to false, then margin is fixed and the value of total will be adjusted, based on the production_costs and margin.
sub_total: required(integer)
Denotes the sub_total price for this production path, which is the total minus any service costs, and must be given in the smallest currency unit of the printery.
total: required(integer)
Denotes the total price for this production path.
discount: required(number - minimum: 0 - maximum: 1)
Denotes the discount, given as a percentage, that should be applied to this production paths costs in order to calculate the total price of the printed goods. The discount is not applied to services associated with the current product.
margin: required(number - minimum: 0)
Denotes the margin that should be applied to the costs of this production path's printed goods.
product_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 34207,
"product_id": 23426,
"state": "done",
"circulation": 300,
"selected_for_production": false,
"show_in_offer": true,
"production_costs": 186335,
"costs_per_unit": "633.54",
"costs_per_thousand": 633540,
"total": 190062,
"margin": "0.02",
"discount": "0.0",
"discounted_total": 190062,
"outsourced": false,
"keep_total": false,
"created_at": "2017-12-12T10:06:04.652+01:00",
"updated_at": "2017-12-12T10:07:38.851+01:00"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/production_paths/{production_path_id} get patch delete

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.

Get a single ProductionPath record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
production_path_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

circulation: required(integer - minimum: 1)
The product's combined circulation, that is the sum of all variants' circulations. This also means, that if you want to change this value, you need to adjust the circulations for the respective variants.
state: required(one of done, pending, preparing, imposing, planning, calculating, error)
Describes the state of this production path. This usually done and only changes when Keyline calculates the conception of the product.
conception_mode: required(one of concurrent, manual)
Describes the conception mode of this production path.
selected_for_production: required(boolean)
Denotes if this production path has been selected for the actual production of the product.
show_in_offer: required(boolean)
Denotes, if this production path with all it's details should be added to the offer that's sent to the customer.
production_costs: required(integer)
costs_per_unit: required(number)
costs_per_thousand: required(integer)
discounted_total: required(integer)
outsourced: required(boolean)
If set to true, no production planning will happen for this production path.
keep_total: required(boolean)
If set to true, then the value for total is fixed and the margin is adjusted. If set to false, then margin is fixed and the value of total will be adjusted, based on the production_costs and margin.
sub_total: required(integer)
Denotes the sub_total price for this production path, which is the total minus any service costs, and must be given in the smallest currency unit of the printery.
total: required(integer)
Denotes the total price for this production path.
discount: required(number - minimum: 0 - maximum: 1)
Denotes the discount, given as a percentage, that should be applied to this production paths costs in order to calculate the total price of the printed goods. The discount is not applied to services associated with the current product.
margin: required(number - minimum: 0)
Denotes the margin that should be applied to the costs of this production path's printed goods.
product_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 34207,
"product_id": 23426,
"state": "done",
"circulation": 300,
"selected_for_production": false,
"show_in_offer": true,
"production_costs": 186335,
"costs_per_unit": "633.54",
"costs_per_thousand": 633540,
"total": 190062,
"margin": "0.02",
"discount": "0.0",
"discounted_total": 190062,
"outsourced": false,
"keep_total": false,
"created_at": "2017-12-12T10:06:04.652+01:00",
"updated_at": "2017-12-12T10:07:38.851+01:00"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given ProductionPath record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
production_path_id: required(string)

Body

Media type: application/json

Type: object

Properties

production_path: required(object)
- show_in_offer: (boolean)
  Denotes, if this production path with all it's details should be added to the offer that's sent to the customer.
- outsourced: (boolean)
  If set to true, no production planning will happen for this production path.
- keep_total: (boolean)
  If set to true, then the value for total is fixed and the margin is adjusted. If set to false, then margin is fixed and
- sub_total: (integer)
  Denotes the sub_total price for this production path, which is the total minus any service costs, and must be given in the smallest currency unit of the printery.
- discount: (number - minimum: 0 - maximum: 1)
  Denotes the discount, given as a percentage, that should be applied to this production paths costs in order to calculate the total price of the printed goods. The discount is not applied to services associated with the current product.
- margin: (number - minimum: 0)
  Denotes the margin that should be applied to the costs of this production path's printed goods.
- conception_mode: (one of concurrent, manual)
  Describes the conception mode of this production path.

Example:

{
"production_path": {
"show_in_offer": false
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given ProductionPath record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
production_path_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/production_paths/{production_path_id}/conceptualize patch

patch

Conceptualize the production path.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
production_path_id: required(string)

HTTP status code 200

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/production_paths/{production_path_id}/circulations get

The collection of Circulations

get

Get a list of all Circulation objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
production_path_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Circulation

circulation: required(object)
- amount: required(integer - minimum: 1)
- variant_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 38433,
"variant_id": 47691,
"amount": 1000,
"created_at": "2017-12-12T10:50:22.770+01:00",
"updated_at": "2017-12-12T10:50:22.770+01:00"
},
{
"id": 38434,
"variant_id": 49742,
"amount": 1000,
"created_at": "2017-12-12T10:50:22.781+01:00",
"updated_at": "2017-12-12T10:50:22.781+01:00"
},
{
"id": 38435,
"variant_id": 49743,
"amount": 1000,
"created_at": "2017-12-12T10:50:22.798+01:00",
"updated_at": "2017-12-12T10:50:22.798+01:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/production_paths/{production_path_id}/circulations/{circulation_id} get patch

The collection of Circulations.

get

Get a single Circulation record.

patch

Update the given Circulation record with provided data.

Get a single Circulation record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
production_path_id: required(string)
circulation_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

circulation: required(object)
- amount: required(integer - minimum: 1)
- variant_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 38433,
"variant_id": 47691,
"amount": 1000,
"created_at": "2017-12-12T10:50:22.770+01:00",
"updated_at": "2017-12-12T10:50:22.770+01:00"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Circulation record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
production_path_id: required(string)
circulation_id: required(string)

Body

Media type: application/json

Type: object

Properties

circulation: required(object)
- amount: required(integer - minimum: 1)

Example:

{
"circulation": {
"amount": 10000
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/variants get post

The collection of Variants

get

Get a list of all Variant objects.

post

Create a new Variant object.

Get a list of all Variant objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Variant

variant: required(object)
- name: required(string - minLength: 1 - maxLength: 200)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 47691,
"name": "French Cards",
"created_at": "2017-11-28T10:21:33.384+01:00",
"updated_at": "2017-12-11T16:38:17.174+01:00"
},
{
"id": 49742,
"name": "English Cards",
"created_at": "2017-12-11T16:38:05.856+01:00",
"updated_at": "2017-12-11T16:38:05.856+01:00"
},
{
"id": 49743,
"name": "German Cards",
"created_at": "2017-12-11T16:38:21.358+01:00",
"updated_at": "2017-12-11T16:38:21.358+01:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Variant object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

Body

Media type: application/json

Type: object

Properties

variant: required(object)
- name: required(string - minLength: 1 - maxLength: 200)

Example:

{
"variant": {
 "name": "English Business Cards"
}
}

HTTP status code 201

This response is returned if creating a new Variant was successful.

Body

Media type: application/json

Type: object

Properties

variant: required(object)
- name: required(string - minLength: 1 - maxLength: 200)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 49742,
"name": "English Cards",
"created_at": "2017-12-11T16:38:05.856+01:00",
"updated_at": "2017-12-11T16:38:05.856+01:00"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/variants/{variant_id} get patch delete

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.

Get a single Variant record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
variant_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

variant: required(object)
- name: required(string - minLength: 1 - maxLength: 200)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 49742,
"name": "English Cards",
"created_at": "2017-12-11T16:38:05.856+01:00",
"updated_at": "2017-12-11T16:38:05.856+01:00"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Variant record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
variant_id: required(string)

Body

Media type: application/json

Type: object

Properties

variant: required(object)
- name: required(string - minLength: 1 - maxLength: 200)

Example:

{
"variant": {
 "name": "English Business Cards"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Variant record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
variant_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/services get post

The collection of Services

get

Get a list of all Service objects.

post

Create a new Service object.

Get a list of all Service objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Service

service: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- category: required(string)
- state: required(one of draft, waiting_for_go, waiting_for_checkpoint, ready, running, completed, exception)
- expected_quantity: required(integer)
  How many, given in the unit, of the services are expected to be needed. This is the basis for calculating the actual costs of the service in the context of the product.
  For example if the costs_per_unit are 1000, and expected_quantity are set to 10, then the overall services will cost 10 * 1000 = 10000 as part of the product this service is associated with.
- actual_quantity: (integer)
- costs_per_unit: required(integer)
  The costs per unit, given in the smallest unit currency of the printery ('cents' in case of EUR).
- costs: required(integer)
- project_management_url: (string)
- completion_required_for: (one of none, prepress, press, postpress)
  See description at ServiceTemplate.completion_required_for
- unit: required(one of hours, minutes, pieces)
- description: (string)
- service_template_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

[
{
"id": 1085,
"service_template_id": 2,
"kind": "Bilder",
"category": "image_editing",
"state": "draft",
"expected_quantity": 2000,
"actual_quantity": null,
"costs_per_unit": 100,
"costs": 0,
"project_management_url": null,
"completion_required_for": null,
"unit": "hours",
"description": null,
"created_at": "2018-12-04T12:30:52.322Z",
"updated_at": "2018-12-04T12:32:10.268Z"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Service object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

Body

Media type: application/json

Type: object

Properties

service: required(object)
- service_template_id: required(integer)
  The id of the ServiceTemplate, this service instance is based on. This is only a required attribute when creating new service instances via POST requests.
- description: (string)
- project_management_url: (string)
- expected_quantity: required(integer)
  How many, given in the unit, of the services are expected to be needed. This is the basis for calculating the actual costs of the service in the context of the product.
  For example if the costs_per_unit are 1000, and expected_quantity are set to 10, then the overall services will cost 10 * 1000 = 10000 as part of the product this service is associated with.

Example:

{
"service": {
"service_template_id": 2,
"expected_quantity": 100
}
}

HTTP status code 201

This response is returned if creating a new Service was successful.

Body

Media type: application/json

Type: object

Properties

service: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- category: required(string)
- state: required(one of draft, waiting_for_go, waiting_for_checkpoint, ready, running, completed, exception)
- expected_quantity: required(integer)
  How many, given in the unit, of the services are expected to be needed. This is the basis for calculating the actual costs of the service in the context of the product.
  For example if the costs_per_unit are 1000, and expected_quantity are set to 10, then the overall services will cost 10 * 1000 = 10000 as part of the product this service is associated with.
- actual_quantity: (integer)
- costs_per_unit: required(integer)
  The costs per unit, given in the smallest unit currency of the printery ('cents' in case of EUR).
- costs: required(integer)
- project_management_url: (string)
- completion_required_for: (one of none, prepress, press, postpress)
  See description at ServiceTemplate.completion_required_for
- unit: required(one of hours, minutes, pieces)
- description: (string)
- service_template_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 1085,
"service_template_id": 6,
"kind": "Bildkosten",
"category": "image_editing",
"state": "draft",
"expected_quantity": 1005,
"actual_quantity": null,
"costs_per_unit": 100,
"costs": 0,
"project_management_url": null,
"completion_required_for": null,
"unit": "hours",
"description": null,
"created_at": "2018-12-04T12:30:52.322Z",
"updated_at": "2018-12-04T12:32:10.268Z"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/services/{service_id} get patch delete

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.

Get a single Service record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
service_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

service: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- kind: required(string)
- category: required(string)
- state: required(one of draft, waiting_for_go, waiting_for_checkpoint, ready, running, completed, exception)
- expected_quantity: required(integer)
  How many, given in the unit, of the services are expected to be needed. This is the basis for calculating the actual costs of the service in the context of the product.
  For example if the costs_per_unit are 1000, and expected_quantity are set to 10, then the overall services will cost 10 * 1000 = 10000 as part of the product this service is associated with.
- actual_quantity: (integer)
- costs_per_unit: required(integer)
  The costs per unit, given in the smallest unit currency of the printery ('cents' in case of EUR).
- costs: required(integer)
- project_management_url: (string)
- completion_required_for: (one of none, prepress, press, postpress)
  See description at ServiceTemplate.completion_required_for
- unit: required(one of hours, minutes, pieces)
- description: (string)
- service_template_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 1085,
"service_template_id": 6,
"kind": "Bildkosten",
"category": "image_editing",
"state": "draft",
"expected_quantity": 1005,
"actual_quantity": null,
"costs_per_unit": 100,
"costs": 0,
"project_management_url": null,
"completion_required_for": null,
"unit": "hours",
"description": null,
"created_at": "2018-12-04T12:30:52.322Z",
"updated_at": "2018-12-04T12:32:10.268Z"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Service record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
service_id: required(string)

Body

Media type: application/json

Type: object

Properties

service: required(object)
- service_template_id: required(integer)
  The id of the ServiceTemplate, this service instance is based on. This is only a required attribute when creating new service instances via POST requests.
- description: (string)
- project_management_url: (string)
- expected_quantity: required(integer)
  How many, given in the unit, of the services are expected to be needed. This is the basis for calculating the actual costs of the service in the context of the product.
  For example if the costs_per_unit are 1000, and expected_quantity are set to 10, then the overall services will cost 10 * 1000 = 10000 as part of the product this service is associated with.

Example:

{
"service": {
"service_template_id": 2,
"expected_quantity": 100
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Service record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
service_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/packagings get post

The collection of Packagings

get

Get a list of all Packaging objects.

post

Create a new Packaging object.

Get a list of all Packaging objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Packaging

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
order_id: required(integer)
The id of the order, this packaging belongs to.
product_id: required(integer)
The id of the product, this packaging belongs to.
target_storage_area_id: required(integer)
The ID of the storage area where this packaging should to be stored.
shipment_id: required(integer)
The id of the shipment, this packaging belongs to when it gets shipped.
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
state: required(one of draft, waiting_for_packing, packing, completed)
description: required(string)
kind: required(one of counting, wrapping, addressing, franking, shrink_wrapping, banding, filing, boxing, palletize, pallet_shrink_wrapping)
guarantee: required(one of none, scan_box_once, scan_each_picked_item)
amount: required(integer)
remainder: required(integer)
completed_amount: required(integer)
deposition: required(one of keep_packing, storage, pickup, shipment)
labeled: required(boolean)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
picks: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- pickable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- pickable_type: required(string)
- packaging_id: required(integer)
  The id of the packaging, this pick belongs to. If it is the first packaging, it must be a Variant, otherwise it must be a Packaging.
- source_storage_area_id: (integer)
  The ID of the storage area from which this packaging should be picked.
- amount_per_packaging: required(integer)
- amount: (integer)
  This field can be left empty if you want to pack everything. If partial packaging is required, the number of products to be packed must be entered here.
- description: (string)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

[
{
    "id": 130507,
    "order_id": 104201,
    "product_id": 130719,
    "target_storage_area_id": null,
    "shipment_id": null,
    "reference": "DQUP79",
    "custom_references": {},
    "state": "draft",
    "description": "",
    "kind": "boxing",
    "guarantee": "none",
    "amount": 0,
    "remainder": false,
    "completed_amount": 0,
    "deposition": "shipment",
    "labeled": false,
    "created_at": "2019-07-09T12:41:50.213Z",
    "updated_at": "2019-07-09T12:41:50.213Z",
    "picks": [
        {
            "id": 176389,
            "pickable_id": 198027,
            "pickable_type": "Variant",
            "packaging_id": 130507,
            "source_storage_area_id": null,
            "amount_per_packaging": 100,
            "amount": null,
            "created_at": "2019-07-09T12:42:08.783Z",
            "updated_at": "2019-07-09T12:42:08.783Z",
            "description": null
        }
    ]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Packaging object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

Body

Media type: application/json

Type: object

Properties

packaging: required(object)
- kind: required(one of counting, wrapping, addressing, franking, shrink_wrapping, banding, filing, boxing, palletize, pallet_shrink_wrapping)
- description: (string)
- guarantee: (one of none, scan_box_once, scan_each_picked_item)
- deposition: (one of keep_packing, storage, pickup, shipment)
- labeled: (boolean)

Example:

{
"packaging": {
"kind": "boxing",
"description": "",
"guarantee": "none",
"deposition": "shipment",
"labeled": false
}
}

HTTP status code 201

This response is returned if creating a new Packaging was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
order_id: required(integer)
The id of the order, this packaging belongs to.
product_id: required(integer)
The id of the product, this packaging belongs to.
target_storage_area_id: required(integer)
The ID of the storage area where this packaging should to be stored.
shipment_id: required(integer)
The id of the shipment, this packaging belongs to when it gets shipped.
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
state: required(one of draft, waiting_for_packing, packing, completed)
description: required(string)
kind: required(one of counting, wrapping, addressing, franking, shrink_wrapping, banding, filing, boxing, palletize, pallet_shrink_wrapping)
guarantee: required(one of none, scan_box_once, scan_each_picked_item)
amount: required(integer)
remainder: required(integer)
completed_amount: required(integer)
deposition: required(one of keep_packing, storage, pickup, shipment)
labeled: required(boolean)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
picks: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- pickable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- pickable_type: required(string)
- packaging_id: required(integer)
  The id of the packaging, this pick belongs to. If it is the first packaging, it must be a Variant, otherwise it must be a Packaging.
- source_storage_area_id: (integer)
  The ID of the storage area from which this packaging should be picked.
- amount_per_packaging: required(integer)
- amount: (integer)
  This field can be left empty if you want to pack everything. If partial packaging is required, the number of products to be packed must be entered here.
- description: (string)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 130507,
"order_id": 104201,
"product_id": 130719,
"target_storage_area_id": null,
"shipment_id": null,
"reference": "DQUP79",
"custom_references": {},
"state": "draft",
"description": "",
"kind": "boxing",
"guarantee": "none",
"amount": 0,
"remainder": false,
"completed_amount": 0,
"deposition": "shipment",
"labeled": false,
"created_at": "2019-07-09T12:41:50.213Z",
"updated_at": "2019-07-09T12:41:50.213Z",
"picks": [
    {
        "id": 176389,
        "pickable_id": 198027,
        "pickable_type": "Variant",
        "packaging_id": 130507,
        "source_storage_area_id": null,
        "amount_per_packaging": 100,
        "amount": null,
        "created_at": "2019-07-09T12:42:08.783Z",
        "updated_at": "2019-07-09T12:42:08.783Z",
        "description": null
    }
]
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/packagings/{packaging_id} get patch delete

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.

Get a single Packaging record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
order_id: required(integer)
The id of the order, this packaging belongs to.
product_id: required(integer)
The id of the product, this packaging belongs to.
target_storage_area_id: required(integer)
The ID of the storage area where this packaging should to be stored.
shipment_id: required(integer)
The id of the shipment, this packaging belongs to when it gets shipped.
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
state: required(one of draft, waiting_for_packing, packing, completed)
description: required(string)
kind: required(one of counting, wrapping, addressing, franking, shrink_wrapping, banding, filing, boxing, palletize, pallet_shrink_wrapping)
guarantee: required(one of none, scan_box_once, scan_each_picked_item)
amount: required(integer)
remainder: required(integer)
completed_amount: required(integer)
deposition: required(one of keep_packing, storage, pickup, shipment)
labeled: required(boolean)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
picks: required(object)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- pickable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- pickable_type: required(string)
- packaging_id: required(integer)
  The id of the packaging, this pick belongs to. If it is the first packaging, it must be a Variant, otherwise it must be a Packaging.
- source_storage_area_id: (integer)
  The ID of the storage area from which this packaging should be picked.
- amount_per_packaging: required(integer)
- amount: (integer)
  This field can be left empty if you want to pack everything. If partial packaging is required, the number of products to be packed must be entered here.
- description: (string)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

{
"id": 130507,
"order_id": 104201,
"product_id": 130719,
"target_storage_area_id": null,
"shipment_id": null,
"reference": "DQUP79",
"custom_references": {},
"state": "draft",
"description": "",
"kind": "boxing",
"guarantee": "none",
"amount": 0,
"remainder": false,
"completed_amount": 0,
"deposition": "shipment",
"labeled": false,
"created_at": "2019-07-09T12:41:50.213Z",
"updated_at": "2019-07-09T12:41:50.213Z",
"picks": [
    {
        "id": 176389,
        "pickable_id": 198027,
        "pickable_type": "Variant",
        "packaging_id": 130507,
        "source_storage_area_id": null,
        "amount_per_packaging": 100,
        "amount": null,
        "created_at": "2019-07-09T12:42:08.783Z",
        "updated_at": "2019-07-09T12:42:08.783Z",
        "description": null
    }
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Packaging record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

Body

Media type: application/json

Type: object

Properties

packaging: required(object)
- kind: required(one of counting, wrapping, addressing, franking, shrink_wrapping, banding, filing, boxing, palletize, pallet_shrink_wrapping)
- description: (string)
- guarantee: (one of none, scan_box_once, scan_each_picked_item)
- deposition: (one of keep_packing, storage, pickup, shipment)
- labeled: (boolean)

Example:

{
"packaging": {
"kind": "boxing",
"description": "",
"guarantee": "none",
"deposition": "shipment",
"labeled": false
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Packaging record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/packagings/{packaging_id}/picks get post

The collection of Picks

get

Get a list of all Pick objects.

post

Create a new Pick object.

Get a list of all Pick objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Pick

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
pickable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
pickable_type: required(string)
packaging_id: required(integer)
The id of the packaging, this pick belongs to. If it is the first packaging, it must be a Variant, otherwise it must be a Packaging.
source_storage_area_id: (integer)
The ID of the storage area from which this packaging should be picked.
amount_per_packaging: required(integer)
amount: (integer)
This field can be left empty if you want to pack everything. If partial packaging is required, the number of products to be packed must be entered here.
description: (string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

[
{
    "id": 176389,
    "pickable_id": 198027,
    "pickable_type": "Variant",
    "packaging_id": 130507,
    "source_storage_area_id": null,
    "amount_per_packaging": 100,
    "amount": null,
    "created_at": "2019-07-09T12:42:08.783Z",
    "updated_at": "2019-07-09T12:42:08.783Z",
    "description": null
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Pick object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

Body

Media type: application/json

Type: object

Properties

pick: required(object)
- pickable_type: required(string)
- packaging_id: required(integer)
  The id of the packaging, this pick belongs to. If it is the first packaging, it must be a Variant, otherwise it must be a Packaging.
- amount_per_packaging: required(integer)
- amount: (integer)
  This field can be left empty if you want to pack everything. If partial packaging is required, the number of products to be packed must be entered here.

Example:

{
"pick": {
"pickable_id": 198027,
"pickable_type": "Variant",
"amount_per_packaging": 100
}
}

HTTP status code 201

This response is returned if creating a new Pick was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
pickable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
pickable_type: required(string)
packaging_id: required(integer)
The id of the packaging, this pick belongs to. If it is the first packaging, it must be a Variant, otherwise it must be a Packaging.
source_storage_area_id: (integer)
The ID of the storage area from which this packaging should be picked.
amount_per_packaging: required(integer)
amount: (integer)
This field can be left empty if you want to pack everything. If partial packaging is required, the number of products to be packed must be entered here.
description: (string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 176389,
"pickable_id": 198027,
"pickable_type": "Variant",
"packaging_id": 130507,
"source_storage_area_id": null,
"amount_per_packaging": 100,
"amount": null,
"created_at": "2019-07-09T12:42:08.783Z",
"updated_at": "2019-07-09T12:42:08.783Z",
"description": null
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/packagings/{packaging_id}/picks/{pick_id} get patch delete

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.

Get a single Pick record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)
pick_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
pickable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
pickable_type: required(string)
packaging_id: required(integer)
The id of the packaging, this pick belongs to. If it is the first packaging, it must be a Variant, otherwise it must be a Packaging.
source_storage_area_id: (integer)
The ID of the storage area from which this packaging should be picked.
amount_per_packaging: required(integer)
amount: (integer)
This field can be left empty if you want to pack everything. If partial packaging is required, the number of products to be packed must be entered here.
description: (string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 176389,
"pickable_id": 198027,
"pickable_type": "Variant",
"packaging_id": 130507,
"source_storage_area_id": null,
"amount_per_packaging": 100,
"amount": null,
"created_at": "2019-07-09T12:42:08.783Z",
"updated_at": "2019-07-09T12:42:08.783Z",
"description": null
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Pick record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)
pick_id: required(string)

Body

Media type: application/json

Type: object

Properties

pick: required(object)
- pickable_type: required(string)
- packaging_id: required(integer)
  The id of the packaging, this pick belongs to. If it is the first packaging, it must be a Variant, otherwise it must be a Packaging.
- amount_per_packaging: required(integer)
- amount: (integer)
  This field can be left empty if you want to pack everything. If partial packaging is required, the number of products to be packed must be entered here.

Example:

{
"pick": {
"pickable_id": 198027,
"pickable_type": "Variant",
"amount_per_packaging": 100
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Pick record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)
pick_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/packagings/{packaging_id}/shipment get post delete

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.

Get the Shipment record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
delivery_contact_phone: (string)
Phone number of delivery recipient.
pick_up_at: (datetime)
The time when the shipment must be collected.
delivery_contact_email: (string)
Email address of delivery recipient.
delivery_instructions: (string)
Delivery instructions.
state: required(one of draft, packed, announced, in_transit, exception, untrackable, delivered)
incoterm: (one of CFR, CIF, CIP, CPT, DAP, DAT, DDP, EXW, FAS, FCA, FOB)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
origin_address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
carrier: (object)
- name: required(string)
- service: required(string)
- automated_labels: required(boolean)
- bill_individual_parcels: required(boolean)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 72940,
"reference": "N7ZT8F",
"delivery_contact_phone": "+4961316171000",
"pick_up_at": null,
"delivery_contact_email": "hello@crispymtn.com",
"delivery_instructions": "Please do not stack!",
"state": "draft",
"incoterm": null,
"created_at": "2019-06-25T10:13:57.864Z",
"updated_at": "2019-07-01T12:47:51.171Z",
"address": {
    "id": 195796,
    "addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Str.",
    "number": "1a",
    "addition": "Hinterhaus",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE",
    "fingerprint": "6e36ed6c1962bec361bee878f71798d5",
    "created_at": "2019-06-25T10:13:57.867Z",
    "updated_at": "2019-06-25T10:13:57.867Z"
},
"origin_address": {
    "id": 552,
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Str.",
    "number": "1a",
    "addition": null,
    "zip_code": "55116",
    "town": "mainz",
    "country_code": "DE",
    "fingerprint": "b70ce8a6d13063d340b878c123e41975",
    "created_at": "2016-07-11T18:36:23.326Z",
    "updated_at": "2019-06-11T12:22:09.986Z"
},
"carrier": {
    "id": 12,
    "name": "DHL",
    "service": "Standard",
    "created_at": "2016-09-26T11:05:48.887Z",
    "updated_at": "2019-06-12T08:18:56.791Z"
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Shipment record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

Body

Media type: application/json

Type: object

Properties

shipment: required(object)
- delivery_contact_phone: (string)
  Phone number of delivery recipient.
- pick_up_at: (datetime)
  The time when the shipment must be collected.
- delivery_contact_email: (string)
  Email address of delivery recipient.
- delivery_instructions: (string)
  Delivery instructions.
- incoterm: (one of CFR, CIF, CIP, CPT, DAP, DAT, DDP, EXW, FAS, FCA, FOB)

Example:

{
"shipment": {
"carrier_id": "12",
"delivery_contact_phone": "+4961316171000",
"delivery_contact_email": "hello@crispymtn.com",
"delivery_instructions": "Please do not stack!",
"incoterm": ""
}
}

HTTP status code 201

This response is returned if creating a new Shipment was successful.

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
delivery_contact_phone: (string)
Phone number of delivery recipient.
pick_up_at: (datetime)
The time when the shipment must be collected.
delivery_contact_email: (string)
Email address of delivery recipient.
delivery_instructions: (string)
Delivery instructions.
state: required(one of draft, packed, announced, in_transit, exception, untrackable, delivered)
incoterm: (one of CFR, CIF, CIP, CPT, DAP, DAT, DDP, EXW, FAS, FCA, FOB)
address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
origin_address: required(object)
An Address object represents a postal Address
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information, usually displayed right below the address.
carrier: (object)
- name: required(string)
- service: required(string)
- automated_labels: required(boolean)
- bill_individual_parcels: required(boolean)
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 72940,
"reference": "N7ZT8F",
"delivery_contact_phone": "+4961316171000",
"pick_up_at": null,
"delivery_contact_email": "hello@crispymtn.com",
"delivery_instructions": "Please do not stack!",
"state": "draft",
"incoterm": null,
"created_at": "2019-06-25T10:13:57.864Z",
"updated_at": "2019-07-01T12:47:51.171Z",
"address": {
    "id": 195796,
    "addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Str.",
    "number": "1a",
    "addition": "Hinterhaus",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE",
    "fingerprint": "6e36ed6c1962bec361bee878f71798d5",
    "created_at": "2019-06-25T10:13:57.867Z",
    "updated_at": "2019-06-25T10:13:57.867Z"
},
"origin_address": {
    "id": 552,
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Str.",
    "number": "1a",
    "addition": null,
    "zip_code": "55116",
    "town": "mainz",
    "country_code": "DE",
    "fingerprint": "b70ce8a6d13063d340b878c123e41975",
    "created_at": "2016-07-11T18:36:23.326Z",
    "updated_at": "2019-06-11T12:22:09.986Z"
},
"carrier": {
    "id": 12,
    "name": "DHL",
    "service": "Standard",
    "created_at": "2016-09-26T11:05:48.887Z",
    "updated_at": "2019-06-12T08:18:56.791Z"
}
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Shipment record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/conception/products/{product_id}/packagings/{packaging_id}/shipment/address get post delete

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.

Get the Address record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

addressee: required(string)
town: required(string)
number: (string)
country_code: required(string)
ISO Country code of country this address is located in.
zip_code: required(string)
street: (string)
addition: (string)
An optional additional information, usually displayed right below the address.

Example:

{
"id": 195900,
"addressee": "Crispy Mountain GmbH",
"street": "Emmerich-Josef-Straße",
"number": "1a",
"addition": null,
"zip_code": "55116",
"town": "Mainz",
"country_code": "DE",
"fingerprint": "0bd0c67b086f05346dac284e606c4d30",
"created_at": "2019-06-27T13:25:52.423Z",
"updated_at": "2019-07-01T11:04:16.228Z"
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Address record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

Body

Media type: application/json

Type: object

Properties

address: required(object)
- addressee: required(string)
- town: required(string)
- number: (string)
- country_code: required(string)
  ISO Country code of country this address is located in.
- zip_code: required(string)
- street: (string)
- addition: (string)
  An optional additional information

Example:

{
"address": {
    "addressee": "Crispy Mountain GmbH",
    "street": "Emmerich-Josef-Straße",
    "number": "1a",
    "zip_code": "55116",
    "town": "Mainz",
    "country_code": "DE"
}
}

HTTP status code 201

This response is returned if creating a new Address was successful.

Body

Media type: application/json

Type: object

Properties

addressee: required(string)
town: required(string)
number: (string)
country_code: required(string)
ISO Country code of country this address is located in.
zip_code: required(string)
street: (string)
addition: (string)
An optional additional information, usually displayed right below the address.

Example:

{
"id": 195900,
"addressee": "Crispy Mountain GmbH",
"street": "Emmerich-Josef-Straße",
"number": "1a",
"addition": null,
"zip_code": "55116",
"town": "Mainz",
"country_code": "DE",
"fingerprint": "0bd0c67b086f05346dac284e606c4d30",
"created_at": "2019-06-27T13:25:52.423Z",
"updated_at": "2019-07-01T11:04:16.228Z"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Address record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)
packaging_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production

/production/tasks get

The collection of Tasks

get

Get a list of all Task objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Task

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
workable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
workable_type: required(string)
state: required(one of draft, waiting_for_go, waiting_for_checkpoint, waiting_for_materials, unfulfillable_material_demand, ready, running, completed, exception, canceled)
checkpoint: required(string)
kind: required(string)
description: required(string)
phase: required(string)
formula_for_preparations: required(string)
formula_for_execution: required(string)
formula_for_cleanup: required(string)
formula_for_additional_external_costs: required(string)
duration_for_preparations: required(integer)
duration_for_execution: required(integer)
duration_for_cleanup: required(integer)
duration: required(integer)
actual_duration_for_preparations: required(integer)
actual_duration_for_execution: required(integer)
actual_duration_for_cleanup: required(integer)
actual_duration: required(integer)
costs_per_hour: required(integer)
additional_external_costs: required(integer)
costs: required(integer)
required_variables: required(object)
automation: required(string)
outsourced: required(boolean)
inline: required(boolean)
actual_duration_for_exception: required(integer)
production_path_id: required(integer)
formula_for_additional_internal_costs: required(string)
additional_internal_costs: required(integer)
means_of_production_id: required(integer)
required_means_of_production_capability: required(string)
duration_for_pause_until_next_task: required(integer)
formula_for_pause_until_next_task: required(string)
manufactured_product: required(string)
product_processing: required(string)
formula_for_amount_of_manufactured_products: required(string)
amount_of_manufactured_products: required(integer)
actual_amount_of_manufactured_products: required(integer)
formula_for_amount_of_wasted_manufactured_products: required(string)
amount_of_wasted_manufactured_products: required(integer)
actual_amount_of_wasted_manufactured_products: required(integer)
minimum_viable_amount_of_manufactured_products: required(integer)
stock_task_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

[
{
  "id": 170889,
  "workable_id": 26130,
  "workable_type": "Finishing",
  "state": "unfulfillable_material_demand",
  "checkpoint": "none",
  "kind": "Handzusammentragen",
  "description": null,
  "phase": "postpress",
  "formula_for_preparations": "30",
  "formula_for_execution": "(number_of_components*5)*(circulation*5)",
  "formula_for_cleanup": "30",
  "formula_for_additional_external_costs": "",
  "duration_for_preparations": 30,
  "duration_for_execution": 3375,
  "duration_for_cleanup": 30,
  "duration": 3435,
  "actual_duration_for_preparations": 30,
  "actual_duration_for_execution": 3375,
  "actual_duration_for_cleanup": 30,
  "actual_duration": 3435,
  "costs_per_hour": 3000,
  "additional_external_costs": 0,
  "costs": 6233,
  "created_at": "2017-09-12T14:12:08.596+02:00",
  "updated_at": "2018-02-14T15:15:33.510+01:00",
  "required_variables": {
      "circulation": {
          "value": 45,
          "errors": false,
          "resolved_by": "product",
          "display_key_as": "Auflage"
      },
      "number_of_components": {
          "value": 3,
          "errors": false,
          "resolved_by": "product",
          "display_key_as": "Anzahl der Komponenten"
      }
  },
  "automation": "for_finishing_with_same_name",
  "outsourced": false,
  "inline": false,
  "actual_duration_for_exception": 0,
  "production_path_id": 24459,
  "formula_for_additional_internal_costs": "",
  "additional_internal_costs": 0,
  "means_of_production_id": 540,
  "required_means_of_production_capability": "Handzusammentragen",
  "duration_for_pause_until_next_task": 0,
  "formula_for_pause_until_next_task": "",
  "manufactured_product": "product",
  "product_processing": "zusammengetragen",
  "formula_for_amount_of_manufactured_products": "circulation",
  "amount_of_manufactured_products": 45,
  "actual_amount_of_manufactured_products": 45,
  "formula_for_amount_of_wasted_manufactured_products": "",
  "amount_of_wasted_manufactured_products": 0,
  "actual_amount_of_wasted_manufactured_products": 0,
  "minimum_viable_amount_of_manufactured_products": 45,
  "stock_task_id": 647
},
{
  "id": 202993,
  "workable_id": 29028,
  "workable_type": "Component",
  "state": "unfulfillable_material_demand",
  "checkpoint": "none",
  "kind": "Digitaldruck",
  "description": null,
  "phase": "press",
  "formula_for_preparations": "ruestgrundzeit*60",
  "formula_for_execution": "IF(machine=\"HP Indigo 7800\",3600/IF(number_of_front_colors<3,IF(number_of_back_colors=0,impressionen_pro_stunde,(IF(number_of_back_colors<3,impressionen_pro_stunde/2,IF(number_of_front_colors=1,impressionen_pro_stunde/(number_of_front_colors+1+number_of_back_colors)*2,impressionen_pro_stunde/(number_of_front_colors+number_of_back_colors)*2)))),IF(number_of_front_colors>2,IF(number_of_back_colors=1,impressionen_pro_stunde/(number_of_front_colors+number_of_back_colors+1)*2,impressionen_pro_stunde/(number_of_front_colors+number_of_back_colors)*2),0))*number_of_sheets,(number_of_front_colors+number_of_back_colors)*number_of_sheets/click_pro_stunde*3600)",
  "formula_for_cleanup": "aufraeumgrundzeit*60",
  "formula_for_additional_external_costs": "IF(machine=\"HP Indigo 7800\",(IF(number_of_colors>2,multi_color_impression*number_of_colors*number_of_sheets,0)+IF(number_of_colors=2,two_color_impression*2*number_of_sheets,0)+IF(number_of_colors=1,one_color_impression*number_of_sheets,0)+IF(epm,epm_impression*number_of_sheets,0))*number_of_printed_surfaces_per_sheet*100+((IF(CONTAINS(front_colors,\"Digimatt Lack\"),2,0)*number_of_sheets)+(IF(CONTAINS(back_colors,\"Digimatt Lack\"),2,0)*number_of_sheets)+(IF(CONTAINS(front_colors,\"deckweiss\"),2,0)*number_of_sheets)+(IF(CONTAINS(back_colors,\"digilack_transparent_glanz\"),2,0)*number_of_sheets)+(IF(CONTAINS(front_colors,\"digilack_transparent_glanz\"),2,0)*number_of_sheets)+(IF(CONTAINS(back_colors,\"deckweiss\"),2,0)*number_of_sheets)),IF(number_of_colors>1,(((number_of_colors-1)*click_multicolor)+click_black)*number_of_sheets,click_black*number_of_sheets)*number_of_printed_surfaces_per_sheet*100)",
  "duration_for_preparations": 300,
  "duration_for_execution": 107,
  "duration_for_cleanup": 300,
  "duration": 707,
  "actual_duration_for_preparations": null,
  "actual_duration_for_execution": null,
  "actual_duration_for_cleanup": null,
  "actual_duration": null,
  "costs_per_hour": 21000,
  "additional_external_costs": 552,
  "costs": 7147,
  "created_at": "2017-11-07T13:34:10.026+01:00",
  "updated_at": "2018-02-14T15:15:23.766+01:00",
  "required_variables": {
      "epm": {
          "value": false,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "EPM"
      },
      "machine": {
          "value": "HP Indigo 12000",
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Maschine"
      },
      "waste_rate": {
          "value": 0.05,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Ausschussrate"
      },
      "back_colors": {
          "value": [],
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Farben der Rückseite"
      },
      "click_black": {
          "value": 0.009,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Click Black"
      },
      "front_colors": {
          "value": [
              "CMYK/Cyan",
              "CMYK/Magenta",
              "CMYK/Yellow",
              "CMYK/Black"
          ],
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Farben der Vorderseite"
      },
      "epm_impression": {
          "value": null,
          "errors": true,
          "resolved_by": "unresolvable",
          "display_key_as": "unresolvable"
      },
      "ruestgrundzeit": {
          "value": 5,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Rüstgrundzeit"
      },
      "click_multicolor": {
          "value": 0.017,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Click Multicolor"
      },
      "click_pro_stunde": {
          "value": 12420,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Click pro Stunde"
      },
      "number_of_colors": {
          "value": 4,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Anzahl der unterschiedlichen Farben"
      },
      "number_of_sheets": {
          "value": 92,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Anzahl der Bogen"
      },
      "aufraeumgrundzeit": {
          "value": 5,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Aufräumgrundzeit"
      },
      "one_color_impression": {
          "value": null,
          "errors": true,
          "resolved_by": "unresolvable",
          "display_key_as": "unresolvable"
      },
      "two_color_impression": {
          "value": null,
          "errors": true,
          "resolved_by": "unresolvable",
          "display_key_as": "unresolvable"
      },
      "number_of_back_colors": {
          "value": 0,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Anzahl der unterschiedlichen Farben für die Rückseite"
      },
      "total_processed_goods": {
          "value": 97,
          "errors": false,
          "resolved_by": "task",
          "display_key_as": "Gesamtmenge der zu verarbeiteten Güter"
      },
      "multi_color_impression": {
          "value": null,
          "errors": true,
          "resolved_by": "unresolvable",
          "display_key_as": "unresolvable"
      },
      "number_of_front_colors": {
          "value": 4,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Anzahl der unterschiedlichen Farben für die Vorderseite"
      },
      "impressionen_pro_stunde": {
          "value": null,
          "errors": true,
          "resolved_by": "unresolvable",
          "display_key_as": "unresolvable"
      },
      "number_of_printed_surfaces_per_sheet": {
          "value": 1,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Anzahl der bedruckten Oberflächen"
      }
  },
  "automation": "for_digital",
  "outsourced": false,
  "inline": false,
  "actual_duration_for_exception": 0,
  "production_path_id": 29193,
  "formula_for_additional_internal_costs": null,
  "additional_internal_costs": 0,
  "means_of_production_id": 919,
  "required_means_of_production_capability": "Digitaldruck",
  "duration_for_pause_until_next_task": 0,
  "formula_for_pause_until_next_task": null,
  "manufactured_product": "sheet",
  "product_processing": "bedruckt",
  "formula_for_amount_of_manufactured_products": "number_of_sheets",
  "amount_of_manufactured_products": 92,
  "actual_amount_of_manufactured_products": 92,
  "formula_for_amount_of_wasted_manufactured_products": "total_processed_goods*waste_rate",
  "amount_of_wasted_manufactured_products": 5,
  "actual_amount_of_wasted_manufactured_products": 0,
  "minimum_viable_amount_of_manufactured_products": 92,
  "stock_task_id": 587
},
{
  "id": 208360,
  "workable_id": 29766,
  "workable_type": "Component",
  "state": "unfulfillable_material_demand",
  "checkpoint": "none",
  "kind": "Vorschneiden",
  "description": null,
  "phase": "prepress",
  "formula_for_preparations": "120",
  "formula_for_execution": "(ROUNDUP(number_of_sheets*IF(paper_thickness=0,0.150,paper_thickness)/einlegehoehe))*(cuts_to_setup*(3600/schnitte_pro_stunde))+(IF(machine=\"Horizon Smart Slitter SMSL-100\", number_of_sheets*2,0) )",
  "formula_for_cleanup": "120",
  "formula_for_additional_external_costs": "0",
  "duration_for_preparations": 120,
  "duration_for_execution": 300,
  "duration_for_cleanup": 120,
  "duration": 540,
  "actual_duration_for_preparations": null,
  "actual_duration_for_execution": null,
  "actual_duration_for_cleanup": null,
  "actual_duration": null,
  "costs_per_hour": 3000,
  "additional_external_costs": 0,
  "costs": 6950,
  "created_at": "2017-11-14T12:22:34.228+01:00",
  "updated_at": "2018-02-14T15:15:32.114+01:00",
  "required_variables": {
      "machine": {
          "value": "Vorschneiden Wareneingang",
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Maschine"
      },
      "einlegehoehe": {
          "value": 70,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Einlegehöhe"
      },
      "cuts_to_setup": {
          "value": 20,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Einzustellende Schnitte"
      },
      "paper_thickness": {
          "value": 0.31,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Papierstärke"
      },
      "number_of_sheets": {
          "value": 20,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Anzahl der Bogen"
      },
      "schnitte_pro_stunde": {
          "value": 240,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Schnitte pro Stunde"
      }
  },
  "automation": "for_precutting",
  "outsourced": false,
  "inline": false,
  "actual_duration_for_exception": 0,
  "production_path_id": 29984,
  "formula_for_additional_internal_costs": null,
  "additional_internal_costs": 0,
  "means_of_production_id": 852,
  "required_means_of_production_capability": "Schneiden",
  "duration_for_pause_until_next_task": 0,
  "formula_for_pause_until_next_task": null,
  "manufactured_product": "sheet",
  "product_processing": "vorgeschnitten",
  "formula_for_amount_of_manufactured_products": "number_of_sheets",
  "amount_of_manufactured_products": 20,
  "actual_amount_of_manufactured_products": 21,
  "formula_for_amount_of_wasted_manufactured_products": null,
  "amount_of_wasted_manufactured_products": 0,
  "actual_amount_of_wasted_manufactured_products": 0,
  "minimum_viable_amount_of_manufactured_products": 21,
  "stock_task_id": 640
},
{
  "id": 211699,
  "workable_id": 30176,
  "workable_type": "Component",
  "state": "unfulfillable_material_demand",
  "checkpoint": "none",
  "kind": "Vorschneiden",
  "description": null,
  "phase": "prepress",
  "formula_for_preparations": "120",
  "formula_for_execution": "(ROUNDUP(number_of_sheets*IF(paper_thickness=0,0.150,paper_thickness)/einlegehoehe))*(cuts_to_setup*(3600/schnitte_pro_stunde))+(IF(machine=\"Horizon Smart Slitter SMSL-100\", number_of_sheets*2,0) )",
  "formula_for_cleanup": "120",
  "formula_for_additional_external_costs": "0",
  "duration_for_preparations": 120,
  "duration_for_execution": 90,
  "duration_for_cleanup": 120,
  "duration": 330,
  "actual_duration_for_preparations": null,
  "actual_duration_for_execution": null,
  "actual_duration_for_cleanup": null,
  "actual_duration": null,
  "costs_per_hour": 3000,
  "additional_external_costs": 0,
  "costs": 2204,
  "created_at": "2017-11-17T13:15:07.729+01:00",
  "updated_at": "2018-02-14T15:15:31.549+01:00",
  "required_variables": {
      "machine": {
          "value": "Vorschneiden Wareneingang",
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Maschine"
      },
      "einlegehoehe": {
          "value": 70,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Einlegehöhe"
      },
      "cuts_to_setup": {
          "value": 6,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Einzustellende Schnitte"
      },
      "paper_thickness": {
          "value": 0,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Papierstärke"
      },
      "number_of_sheets": {
          "value": 8,
          "errors": false,
          "resolved_by": "component",
          "display_key_as": "Anzahl der Bogen"
      },
      "schnitte_pro_stunde": {
          "value": 240,
          "errors": false,
          "resolved_by": "means_of_production",
          "display_key_as": "Schnitte pro Stunde"
      }
  },
  "automation": "for_precutting",
  "outsourced": false,
  "inline": false,
  "actual_duration_for_exception": 0,
  "production_path_id": 30618,
  "formula_for_additional_internal_costs": null,
  "additional_internal_costs": 0,
  "means_of_production_id": 852,
  "required_means_of_production_capability": "Schneiden",
  "duration_for_pause_until_next_task": 0,
  "formula_for_pause_until_next_task": null,
  "manufactured_product": "sheet",
  "product_processing": "vorgeschnitten",
  "formula_for_amount_of_manufactured_products": "number_of_sheets",
  "amount_of_manufactured_products": 8,
  "actual_amount_of_manufactured_products": 9,
  "formula_for_amount_of_wasted_manufactured_products": null,
  "amount_of_wasted_manufactured_products": 0,
  "actual_amount_of_wasted_manufactured_products": 0,
  "minimum_viable_amount_of_manufactured_products": 9,
  "stock_task_id": 640
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production/tasks/{task_id} get patch delete

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.

Get a single Task record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
workable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
workable_type: required(string)
state: required(one of draft, waiting_for_go, waiting_for_checkpoint, waiting_for_materials, unfulfillable_material_demand, ready, running, completed, exception, canceled)
checkpoint: required(string)
kind: required(string)
description: required(string)
phase: required(string)
formula_for_preparations: required(string)
formula_for_execution: required(string)
formula_for_cleanup: required(string)
formula_for_additional_external_costs: required(string)
duration_for_preparations: required(integer)
duration_for_execution: required(integer)
duration_for_cleanup: required(integer)
duration: required(integer)
actual_duration_for_preparations: required(integer)
actual_duration_for_execution: required(integer)
actual_duration_for_cleanup: required(integer)
actual_duration: required(integer)
costs_per_hour: required(integer)
additional_external_costs: required(integer)
costs: required(integer)
required_variables: required(object)
automation: required(string)
outsourced: required(boolean)
inline: required(boolean)
actual_duration_for_exception: required(integer)
production_path_id: required(integer)
formula_for_additional_internal_costs: required(string)
additional_internal_costs: required(integer)
means_of_production_id: required(integer)
required_means_of_production_capability: required(string)
duration_for_pause_until_next_task: required(integer)
formula_for_pause_until_next_task: required(string)
manufactured_product: required(string)
product_processing: required(string)
formula_for_amount_of_manufactured_products: required(string)
amount_of_manufactured_products: required(integer)
actual_amount_of_manufactured_products: required(integer)
formula_for_amount_of_wasted_manufactured_products: required(string)
amount_of_wasted_manufactured_products: required(integer)
actual_amount_of_wasted_manufactured_products: required(integer)
minimum_viable_amount_of_manufactured_products: required(integer)
stock_task_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.

Example:

{
"id": 170889,
"workable_id": 26130,
"workable_type": "Finishing",
"state": "unfulfillable_material_demand",
"checkpoint": "none",
"kind": "Handzusammentragen",
"description": null,
"phase": "postpress",
"formula_for_preparations": "30",
"formula_for_execution": "(number_of_components*5)*(circulation*5)",
"formula_for_cleanup": "30",
"formula_for_additional_external_costs": "",
"duration_for_preparations": 30,
"duration_for_execution": 3375,
"duration_for_cleanup": 30,
"duration": 3435,
"actual_duration_for_preparations": 30,
"actual_duration_for_execution": 3375,
"actual_duration_for_cleanup": 30,
"actual_duration": 3435,
"costs_per_hour": 3000,
"additional_external_costs": 0,
"costs": 6233,
"created_at": "2017-09-12T14:12:08.596+02:00",
"updated_at": "2018-02-14T15:15:33.510+01:00",
"required_variables": {
  "circulation": {
      "value": 45,
      "errors": false,
      "resolved_by": "product",
      "display_key_as": "Auflage"
  },
  "number_of_components": {
      "value": 3,
      "errors": false,
      "resolved_by": "product",
      "display_key_as": "Anzahl der Komponenten"
  }
},
"automation": "for_finishing_with_same_name",
"outsourced": false,
"inline": false,
"actual_duration_for_exception": 0,
"production_path_id": 24459,
"formula_for_additional_internal_costs": "",
"additional_internal_costs": 0,
"means_of_production_id": 540,
"required_means_of_production_capability": "Handzusammentragen",
"duration_for_pause_until_next_task": 0,
"formula_for_pause_until_next_task": "",
"manufactured_product": "product",
"product_processing": "zusammengetragen",
"formula_for_amount_of_manufactured_products": "circulation",
"amount_of_manufactured_products": 45,
"actual_amount_of_manufactured_products": 45,
"formula_for_amount_of_wasted_manufactured_products": "",
"amount_of_wasted_manufactured_products": 0,
"actual_amount_of_wasted_manufactured_products": 0,
"minimum_viable_amount_of_manufactured_products": 45,
"stock_task_id": 647
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Task record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)

Body

Media type: application/json

Type: object

Properties

task_execution: required(object)
- state: required(one of draft, waiting_for_go, waiting_for_checkpoint, waiting_for_materials, unfulfillable_material_demand, ready, running, completed, exception, canceled)
- actual_amount_of_manufactured_products: required(integer)
- actual_amount_of_wasted_manufactured_products: required(integer)

Example:

{
"task": {
"state": "completed",
"actual_amount_of_manufactured_products": 200,
"actual_amount_of_wasted_manufactured_products": 10
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Set a task to canceled.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production/tasks/{task_id}/task_executions get post

The collection of TaskExecutions

get

Get a list of all TaskExecution objects.

post

Create a new TaskExecution object.

Get a list of all TaskExecution objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: TaskExeuction

phase: required(one of preparations, execution, cleanup, exception)
performer_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
started_at: required(datetime)
finished_at: required(datetime)
duration: required(integer)
comment: required(string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
  "id": 144030,
  "task_id": 170889,
  "performer_id": null,
  "phase": "cleanup",
  "started_at": "2018-02-07T13:35:39.277+01:00",
  "finished_at": "2018-02-07T13:36:09.277+01:00",
  "duration": 30,
  "created_at": "2018-02-07T13:36:09.279+01:00",
  "updated_at": "2018-02-07T13:36:09.279+01:00"
},
{
  "id": 144031,
  "task_id": 170889,
  "performer_id": null,
  "phase": "execution",
  "started_at": "2018-02-07T12:39:23.277+01:00",
  "finished_at": "2018-02-07T13:35:38.277+01:00",
  "duration": 3375,
  "created_at": "2018-02-07T13:36:09.475+01:00",
  "updated_at": "2018-02-07T13:36:09.475+01:00"
},
{
  "id": 144032,
  "task_id": 170889,
  "performer_id": null,
  "phase": "preparations",
  "started_at": "2018-02-07T12:38:52.277+01:00",
  "finished_at": "2018-02-07T12:39:22.277+01:00",
  "duration": 30,
  "created_at": "2018-02-07T13:36:09.497+01:00",
  "updated_at": "2018-02-07T13:36:09.497+01:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new TaskExecution object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)

Body

Media type: application/json

Type: object

Properties

task_execution: required(object)
- phase: required(one of preparations, execution, cleanup, exception)
- performer_id: (integer)
  Performer is the user who runs the task (user_id)
- finished_at: required(datetime)
- comment: (string)
  Allow to describe an error in the case of an exception

Example:

{
"task_execution": {
"phase": "cleanup",
"performer_id": 12
}
}

HTTP status code 201

This response is returned if creating a new TaskExecution was successful.

Body

Media type: application/json

Type: object

Properties

phase: required(one of preparations, execution, cleanup, exception)
performer_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
started_at: required(datetime)
finished_at: required(datetime)
duration: required(integer)
comment: required(string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 144032,
"task_id": 170889,
"performer_id": null,
"phase": "preparations",
"started_at": "2018-02-07T12:38:52.277+01:00",
"finished_at": "2018-02-07T12:39:22.277+01:00",
"duration": 30,
"created_at": "2018-02-07T13:36:09.497+01:00",
"updated_at": "2018-02-07T13:36:09.497+01:00"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production/tasks/{task_id}/task_executions/{task_execution_id} patch

The collection of TaskExecutions.

patch

Update the given TaskExecution record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)
task_execution_id: required(string)

Body

Media type: application/json

Type: object

Properties

task_execution: required(object)
- phase: required(one of preparations, execution, cleanup, exception)
- performer_id: (integer)
  Performer is the user who runs the task (user_id)
- finished_at: required(datetime)
- comment: (string)
  Allow to describe an error in the case of an exception

Example:

{
"task_execution": {
"finished_at": "2018-02-07T12:39:22.277+01:00"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production/tasks/{task_id}/material_demands get post

The collection of MaterialDemands

get

Get a list of all MaterialDemand objects.

post

Create a new MaterialDemand object.

Get a list of all MaterialDemand objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: MaterialDemand

material_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
raw_material_requirement_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
name: required(string)
unit: required(string)
processings: required(string)
formula: required(string)
expected_costs: required(integer)
expected_qty: required(integer)
actual_qty: required(integer)
sku: required(integer)
required_variables: required(object)
costs_per_sku_as_calculated: required(number)
costs_per_sku_as_set_manually: required(number)
material_delivery_id: required(integer)
actual_costs: required(integer)
unfulfillable: required(boolean)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
  "id": 535756,
  "material_id": 158857,
  "raw_material_requirement_id": 98061,
  "name": "Taschen",
  "unit": "piece",
  "processings": [],
  "formula": "circulation",
  "expected_costs": 2470,
  "expected_qty": 45,
  "actual_qty": 45,
  "created_at": "2017-09-12T14:12:10.010+02:00",
  "updated_at": "2018-02-07T13:36:09.566+01:00",
  "sku": 1,
  "required_variables": {
      "circulation": {
          "value": 45,
          "errors": false,
          "resolved_by": "product",
          "display_key_as": "Auflage"
      }
  },
  "costs_per_sku_as_calculated": "54.88889",
  "costs_per_sku_as_set_manually": null,
  "material_delivery_id": 5013,
  "actual_costs": null,
  "unfulfillable": true
},
{
  "id": 535755,
  "material_id": 158859,
  "raw_material_requirement_id": 98062,
  "name": "Folien",
  "unit": "piece",
  "processings": [],
  "formula": "circulation",
  "expected_costs": 900,
  "expected_qty": 45,
  "actual_qty": 45,
  "created_at": "2017-09-12T14:12:09.925+02:00",
  "updated_at": "2018-02-07T13:36:09.586+01:00",
  "sku": 1,
  "required_variables": {
      "circulation": {
          "value": 45,
          "errors": false,
          "resolved_by": "product",
          "display_key_as": "Auflage"
      }
  },
  "costs_per_sku_as_calculated": "20.0",
  "costs_per_sku_as_set_manually": null,
  "material_delivery_id": 5014,
  "actual_costs": null,
  "unfulfillable": true
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new MaterialDemand object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)

Body

Media type: application/json

Type: object

Properties

material_demand: required(object)
- actual_qty: required(integer)

HTTP status code 201

This response is returned if creating a new MaterialDemand was successful.

Body

Media type: application/json

Type: object

Properties

material_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
raw_material_requirement_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
name: required(string)
unit: required(string)
processings: required(string)
formula: required(string)
expected_costs: required(integer)
expected_qty: required(integer)
actual_qty: required(integer)
sku: required(integer)
required_variables: required(object)
costs_per_sku_as_calculated: required(number)
costs_per_sku_as_set_manually: required(number)
material_delivery_id: required(integer)
actual_costs: required(integer)
unfulfillable: required(boolean)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production/tasks/{task_id}/material_demands/{material_demand_id} patch

The collection of MaterialDemands.

patch

Update the given MaterialDemand record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

task_id: required(string)
material_demand_id: required(string)

Body

Media type: application/json

Type: object

Properties

material_demand: required(object)
- actual_qty: required(integer)

Example:

{
"material_demand": {
"actual_qty": "10"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production/means_of_productions/{means_of_production_id}/tasks get

The collection of Tasks

get

Get a list of all Task objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

means_of_production_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Task

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
workable_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
workable_type: required(string)
state: required(one of draft, waiting_for_go, waiting_for_checkpoint, waiting_for_materials, unfulfillable_material_demand, ready, running, completed, exception, canceled)
checkpoint: required(string)
kind: required(string)
phase: required(string)
duration_for_preparations: required(integer)
duration_for_execution: required(integer)
duration_for_cleanup: required(integer)
inline: required(boolean)
means_of_production_id: required(integer)
product_id: required(integer)
manufactured_product: required(string)
product_processing: required(string)
amount_of_manufactured_products: required(integer)
amount_of_wasted_manufactured_products: required(integer)
minimum_viable_amount_of_manufactured_products: required(integer)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
production_slots: (array of object)
Items: ProductionSlot
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- starts_at: required(datetime)
- ends_at: required(datetime)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.

Example:

[
{
"id": 529479,
"workable_type": "Component",
"workable_id": 89899,
"kind": "Falzen",
"phase": "postpress",
"state": "waiting_for_go",
"outsourced": false,
"inline": false,
"checkpoint": "none",
"duration_for_preparations": 1860,
"duration_for_execution": 480,
"duration_for_cleanup": 300,
"duration_for_pause_until_next_task": 0,
"manufactured_product": "product",
"product_processing": "gefalzt",
"minimum_viable_amount_of_manufactured_products": 1000,
"amount_of_manufactured_products": 1000,
"amount_of_wasted_manufactured_products": 0,
"created_at": "2018-09-18T08:58:51.517+02:00",
"updated_at": "2018-09-18T09:04:14.862+02:00",
"product_id": 73618,
"production_slots": [
  {
    "id": 106338403,
    "starts_at": "2018-09-19T10:01:23.000+02:00",
    "ends_at": "2018-09-19T10:45:23.000+02:00",
    "created_at": "2018-09-18T13:15:44.441+02:00",
    "updated_at": "2018-09-18T13:15:44.441+02:00"
  }
]
},
{
"id": 529485,
"workable_type": "Component",
"workable_id": 89900,
"kind": "Falzen",
"phase": "postpress",
"state": "waiting_for_go",
"outsourced": false,
"inline": false,
"checkpoint": "none",
"duration_for_preparations": 1860,
"duration_for_execution": 960,
"duration_for_cleanup": 300,
"duration_for_pause_until_next_task": 0,
"manufactured_product": "product",
"product_processing": "gefalzt",
"minimum_viable_amount_of_manufactured_products": 2000,
"amount_of_manufactured_products": 2000,
"amount_of_wasted_manufactured_products": 0,
"created_at": "2018-09-18T09:03:27.803+02:00",
"updated_at": "2018-09-18T09:04:14.944+02:00",
"product_id": 73618,
"production_slots": [
  {
    "id": 106338402,
    "starts_at": "2018-09-18T15:54:42.292+02:00",
    "ends_at": "2018-09-18T16:46:42.292+02:00",
    "created_at": "2018-09-18T13:15:44.354+02:00",
    "updated_at": "2018-09-18T13:15:44.354+02:00"
  }
]
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production/means_of_productions/{means_of_production_id}/counter post

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

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

means_of_production_id: required(string)

Body

Media type: application/json

Type: object

Properties

counter: required(object)
- value: required(integer)

Example:

{
"counter": {
"value": 25
}
}

HTTP status code 200

Body

Media type: text/html

Type: any

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{
"errors": {
"means_of_production": [
  "no running tasks"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/production/products/{product_id}/production_path get

The ProductionPath record associated with the parent record.

get

Get the ProductionPath record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

product_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
product_id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
tasks: (array of object)
Items: Task
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- workable_id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- workable_type: required(string)
- state: required(one of draft, waiting_for_go, waiting_for_checkpoint, waiting_for_materials, unfulfillable_material_demand, ready, running, completed, exception, canceled)
- checkpoint: required(string)
- kind: required(string)
- phase: required(string)
- duration_for_preparations: required(integer)
- duration_for_execution: required(integer)
- duration_for_cleanup: required(integer)
- outsourced: required(boolean)
- inline: required(boolean)
- manufactured_product: required(string)
- product_processing: required(string)
- amount_of_manufactured_products: required(integer)
- amount_of_wasted_manufactured_products: required(integer)
- minimum_viable_amount_of_manufactured_products: required(integer)
- dependent_task_ids: (array of object)
  Items: Task
  - id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
- production_slots: (array of object)
  Items: ProductionSlot
  - id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
  - starts_at: required(datetime)
  - ends_at: required(datetime)
  - created_at: required(datetime)
    The exact time the respective object was created.
  - updated_at: required(datetime)
    The exact time the respective object was last updated.
- means_of_production: (object)
  - id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
  - name: required(string)
  - kind: required(string)
  - created_at: required(datetime)
    The exact time the respective object was created.
  - updated_at: required(datetime)
    The exact time the respective object was last updated.
- material_demands: (array of object)
  Items: MaterialDemand
  - id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
  - material_id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
  - name: required(string)
  - unit: required(string)
  - actual_qty: required(integer)
  - created_at: required(datetime)
    The exact time the respective object was created.
  - updated_at: required(datetime)
    The exact time the respective object was last updated.
  - qty: required(integer)
  - material: required(object)
    id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
    name: required(string)
    height: required(number)
    width: required(number)
    depth: required(number)
    weight: required(number)
    kind: required(string)
    billing_mode: required(string)
    created_at: required(datetime)
    The exact time the respective object was created.
    updated_at: required(datetime)
    The exact time the respective object was last updated.
- executions: (object)
  - id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
  - phase: required(one of preparations, execution, cleanup, exception)
  - performer: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
  - started_at: required(datetime)
  - finished_at: required(datetime)
  - created_at: required(datetime)
    The exact time the respective object was created.
  - updated_at: required(datetime)
    The exact time the respective object was last updated.
- checkpoint_clearances: (object)
  - id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
  - user_id: required(integer - minimum: 1)
    Unique identifier for every object. Is used when referencing resources in URLs.
  - created_at: required(datetime)
    The exact time the respective object was created.
  - updated_at: required(datetime)
    The exact time the respective object was last updated.

Example:

{
"id": 161625,
"product_id": 108400,
"created_at": "2019-04-04T17:25:14.775Z",
"updated_at": "2019-07-10T08:54:46.931Z",
"tasks": [
    {
        "id": 983387,
        "workable_type": "Packaging",
        "workable_id": 106114,
        "kind": "Wrapping",
        "phase": "packing",
        "state": "waiting_for_go",
        "inline": false,
        "checkpoint": "none",
        "duration_for_preparations": 0,
        "duration_for_execution": 36,
        "duration_for_cleanup": 0,
        "duration_for_pause_until_next_task": 0,
        "manufactured_product": "collection",
        "product_processing": "wrapped",
        "minimum_viable_amount_of_manufactured_products": 1,
        "amount_of_manufactured_products": 1,
        "amount_of_wasted_manufactured_products": 0,
        "created_at": "2019-04-04T17:25:15.141Z",
        "updated_at": "2019-04-04T17:32:01.129Z",
        "outsourced": false,
        "dependent_task_ids": [],
        "means_of_production": {
            "id": 2997,
            "name": "Hand worker",
            "kind": "specialist",
            "created_at": "2018-10-09T11:57:48.381Z",
            "updated_at": "2019-04-01T13:25:30.410Z"
        },
        "production_slots": [
            {
                "id": 260021097,
                "starts_at": "2019-07-09T07:44:58.000Z",
                "ends_at": "2019-07-09T07:45:34.000Z",
                "created_at": "2019-07-08T14:23:00.482Z",
                "updated_at": "2019-07-08T14:23:00.482Z"
            }
        ],
        "material_demands": [
            {
                "id": 1130730,
                "material_id": 383479,
                "name": "Packing material",
                "unit": "piece",
                "actual_qty": null,
                "created_at": "2019-04-04T17:25:15.347Z",
                "updated_at": "2019-04-04T17:25:16.094Z",
                "qty": 1,
                "material": {
                    "id": 383479,
                    "name": "Stocktube Postal Tube A2",
                    "height": "450.0",
                    "width": "50.0",
                    "depth": null,
                    "weight": null,
                    "kind": "Packing material",
                    "billing_mode": "actual_consumption",
                    "created_at": "2019-01-21T09:37:46.623Z",
                    "updated_at": "2019-01-21T09:39:40.489Z"
                }
            }
        ],
        "executions": [],
        "checkpoint_clearances": []
    },
    {
        "id": 983383,
        "workable_type": "Component",
        "workable_id": 137551,
        "kind": "Hand cutting",
        "phase": "postpress",
        "state": "waiting_for_go",
        "inline": false,
        "checkpoint": "none",
        "duration_for_preparations": 60,
        "duration_for_execution": 120,
        "duration_for_cleanup": 0,
        "duration_for_pause_until_next_task": 0,
        "manufactured_product": "product",
        "product_processing": "Hand cutting",
        "minimum_viable_amount_of_manufactured_products": 1,
        "amount_of_manufactured_products": 1,
        "amount_of_wasted_manufactured_products": 0,
        "created_at": "2019-04-04T17:25:15.093Z",
        "updated_at": "2019-04-04T17:32:01.187Z",
        "outsourced": false,
        "dependent_task_ids": [
            983387
        ],
        "means_of_production": {
            "id": 2997,
            "name": "Hand worker",
            "kind": "specialist",
            "created_at": "2018-10-09T11:57:48.381Z",
            "updated_at": "2019-04-01T13:25:30.410Z"
        },
        "production_slots": [
            {
                "id": 260021096,
                "starts_at": "2019-07-09T07:41:58.000Z",
                "ends_at": "2019-07-09T07:44:58.000Z",
                "created_at": "2019-07-08T14:23:00.482Z",
                "updated_at": "2019-07-08T14:23:00.482Z"
            }
        ],
        "material_demands": [],
        "executions": [],
        "checkpoint_clearances": []
    },
    {
        "id": 983381,
        "workable_type": "Product",
        "workable_id": 108400,
        "kind": "proofing print data",
        "phase": "prepress",
        "state": "completed",
        "inline": false,
        "checkpoint": "none",
        "duration_for_preparations": 0,
        "duration_for_execution": 720,
        "duration_for_cleanup": 0,
        "duration_for_pause_until_next_task": 0,
        "manufactured_product": "file",
        "product_processing": "proofed",
        "minimum_viable_amount_of_manufactured_products": 1,
        "amount_of_manufactured_products": 1,
        "amount_of_wasted_manufactured_products": 0,
        "created_at": "2019-04-04T17:25:15.060Z",
        "updated_at": "2019-07-10T08:54:46.898Z",
        "outsourced": false,
        "dependent_task_ids": [
            983385
        ],
        "means_of_production": {
            "id": 2996,
            "name": "Media designer",
            "kind": "specialist",
            "created_at": "2018-10-09T11:57:48.255Z",
            "updated_at": "2019-04-02T10:28:44.745Z"
        },
        "production_slots": [
            {
                "id": 260021070,
                "starts_at": "2019-07-09T07:12:00.000Z",
                "ends_at": "2019-07-09T07:24:00.000Z",
                "created_at": "2019-07-08T14:23:00.482Z",
                "updated_at": "2019-07-08T14:23:00.482Z"
            }
        ],
        "material_demands": [],
        "executions": [
            {
                "id": 444421,
                "phase": "execution",
                "started_at": "2019-07-10T08:42:44.520Z",
                "finished_at": "2019-07-10T08:54:44.520Z",
                "created_at": "2019-07-10T08:54:44.542Z",
                "updated_at": "2019-07-10T08:54:44.542Z",
                "performer": null
            }
        ],
        "checkpoint_clearances": []
    },
    {
        "id": 983385,
        "workable_type": "Component",
        "workable_id": 137551,
        "kind": "Wide Format printing",
        "phase": "press",
        "state": "unfulfillable_material_demand",
        "inline": false,
        "checkpoint": "none",
        "duration_for_preparations": 120,
        "duration_for_execution": 838,
        "duration_for_cleanup": 120,
        "duration_for_pause_until_next_task": 0,
        "manufactured_product": "roll-metre",
        "product_processing": "wide format printed",
        "minimum_viable_amount_of_manufactured_products": 1,
        "amount_of_manufactured_products": 1,
        "amount_of_wasted_manufactured_products": 0,
        "created_at": "2019-04-04T17:25:15.120Z",
        "updated_at": "2019-07-10T08:54:45.763Z",
        "outsourced": false,
        "dependent_task_ids": [
            983383
        ],
        "means_of_production": {
            "id": 3011,
            "name": "VersaArt RE 640",
            "kind": "digital_web_printer",
            "created_at": "2018-10-10T07:26:52.173Z",
            "updated_at": "2019-04-29T19:15:39.549Z"
        },
        "production_slots": [
            {
                "id": 260021158,
                "starts_at": "2019-07-09T07:24:00.000Z",
                "ends_at": "2019-07-09T07:41:58.000Z",
                "created_at": "2019-07-08T14:23:00.482Z",
                "updated_at": "2019-07-08T14:23:00.482Z"
            }
        ],
        "material_demands": [
            {
                "id": 1130731,
                "material_id": 459308,
                "name": "Sihl Trisolv Silk - 1270mm – 1270mm × 50000mm – 200 gr/m² – White",
                "unit": "roll",
                "actual_qty": null,
                "created_at": "2019-04-04T17:25:15.372Z",
                "updated_at": "2019-07-10T08:54:45.759Z",
                "qty": 2,
                "material": {
                    "id": 459308,
                    "name": "Sihl Trisolv Silk - 1270mm – 1270mm × 50000mm – 200 gr/m² – White",
                    "height": "50.0",
                    "width": "1.27",
                    "depth": null,
                    "weight": "0.254",
                    "kind": "Paper",
                    "billing_mode": "actual_consumption",
                    "created_at": "2019-03-05T10:06:39.297Z",
                    "updated_at": "2019-03-05T10:14:47.469Z"
                }
            }
        ],
        "executions": [],
        "checkpoint_clearances": []
    }
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/warehouse

/warehouse/materials get post

The collection of Materials

get

Get a list of all Material objects.

post

Create a new Material object.

Get a list of all Material objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Material

name: required(string - minLength: 1 - maxLength: 200)
description: (string)
kind: required(string)
Allows categorization of materials.
product_related_ordering: required(boolean)
billing_mode: required(one of full_sku, actual_consumption)
unit: required(one of piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
height: (number)
width: (number)
depth: (number)
weight: (number)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 209524,
"name": "Box - 325 x 220 x 160 mm - (Small)",
"description": null,
"kind": "Boxes",
"unit": "piece",
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": true,
"created_at": "2017-12-14T15:52:04.223+01:00",
"updated_at": "2017-12-14T15:57:06.622+01:00"
},
{
"id": 208125,
"name": "Planosuperior – 210mm × 148mm bei 80 gr/m² (Breitbahn) – hochweiß",
"description": null,
"kind": "Papier",
"unit": "sheet",
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": true,
"created_at": "2017-10-04T14:16:26.079+02:00",
"updated_at": "2017-10-04T14:16:26.079+02:00"
},
{
"id": 208124,
"name": "Multidesign Natural Natural – 324mm × 229mm bei 120 gr/m² – natural",
"description": null,
"kind": "Papier",
"unit": "sheet",
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": true,
"created_at": "2017-10-04T14:12:08.680+02:00",
"updated_at": "2017-10-04T14:12:08.680+02:00"
},
{
"id": 208123,
"name": "Zeta Matt Wz Natur – 610mm × 430mm bei 80 gr/m² (Schmalbahn)",
"description": null,
"kind": "Papier",
"unit": "sheet",
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": true,
"created_at": "2017-10-04T14:10:42.568+02:00",
"updated_at": "2017-10-04T14:10:42.568+02:00"
},
{
"id": 208121,
"name": "Gohrsmühle Bankpost O.Wz Hochweiß – 610mm × 430mm bei 110 gr/m² (Schmalbahn)",
"description": null,
"kind": "Papier",
"unit": "sheet",
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": true,
"created_at": "2017-10-04T11:59:39.211+02:00",
"updated_at": "2017-10-04T11:59:39.211+02:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new Material object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Body

Media type: application/json

Type: object

Properties

material: required(object)
- name: required(string)
- description: (string)
- unit: required(one of piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- customer_id: (integer)
  The id of the customer this order should be associated to.
- kind: (string)
  Allows categorization of materials.
- product_related_ordering: required(boolean)
- billing_mode: required(one of full_sku, actual_consumption)
- height: (number)
  in mm
- width: (number)
  in mm
- depth: (number)
  in mm
- weight: (number)
  in mm

Example:

{
"material": {
"name": "Box (Small) 325 x 220 x 160 mm",
"description": "Box for packaging",
"kind": "Boxes",
"unit": "piece",
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": false
}
}

HTTP status code 201

This response is returned if creating a new Material was successful.

Body

Media type: application/json

Type: object

Properties

name: required(string - minLength: 1 - maxLength: 200)
description: (string)
kind: required(string)
Allows categorization of materials.
product_related_ordering: required(boolean)
billing_mode: required(one of full_sku, actual_consumption)
unit: required(one of piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
height: (number)
width: (number)
depth: (number)
weight: (number)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 209524,
"name": "Box (Small) 325 x 220 x 160 mm",
"description": null,
"kind": "Boxes",
"unit": "piece",
"storage_area_id": null,
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": false,
"created_at": "2017-12-14T15:52:04.223+01:00",
"updated_at": "2017-12-14T15:52:04.223+01:00",
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/warehouse/materials/{material_id} get patch delete

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.

Get a single Material record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

material_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string - minLength: 1 - maxLength: 200)
description: (string)
kind: required(string)
Allows categorization of materials.
product_related_ordering: required(boolean)
billing_mode: required(one of full_sku, actual_consumption)
unit: required(one of piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
height: (number)
width: (number)
depth: (number)
weight: (number)
storage_areas: (array of object)
Items: MaterialStorageArea
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- reference: required(string - pattern: ^[0-9A-Z]{6}$)
  A 6-character, alphanumeric string, that uniquely identifies an object.
  Example:
```
N4XTC8
```
- kind: required(string)
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 147257,
"name": "Recystar Nature Iso 80 / Cie 90 – 630mm × 880mm bei 150 gr/m² (Breitbahn)",
"description": null,
"kind": "Papier",
"unit": "sheet",
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": true,
"created_at": "2017-05-02T11:53:41.762+02:00",
"updated_at": "2017-05-02T11:53:41.762+02:00",
"storage_areas": [
{
  "id": 767,
  "name": "Papierlager",
  "reference": "HDCCG8",
  "kind": "storage",
  "created_at": "2016-08-11T19:57:08.596+02:00",
  "updated_at": "2017-12-14T16:39:29.356+01:00"
}
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given Material record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

material_id: required(string)

Body

Media type: application/json

Type: object

Properties

material: required(object)
- name: required(string)
- description: (string)
- unit: required(one of piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- customer_id: (integer)
  The id of the customer this order should be associated to.
- kind: (string)
  Allows categorization of materials.
- product_related_ordering: required(boolean)
- billing_mode: required(one of full_sku, actual_consumption)
- height: (number)
  in mm
- width: (number)
  in mm
- depth: (number)
  in mm
- weight: (number)
  in mm

Example:

{
"material": {
"name": "Box (Small) 325 x 220 x 160 mm",
"description": "Box for packaging",
"kind": "Boxes",
"unit": "piece",
"billing_mode": "full_sku",
"height": null,
"width": null,
"depth": null,
"weight": null,
"product_related_ordering": false
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given Material record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

material_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/warehouse/storage_areas get post

The collection of StorageAreas

get

Get a list of all StorageArea objects.

post

Create a new StorageArea object.

Get a list of all StorageArea objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: StorageArea

name: required(string - minLength: 1 - maxLength: 200)
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
kind: required(one of storage, shopfloor, incoming, outgoing, picking)
materials: (array of object)
Items: Material
- name: required(string - minLength: 1 - maxLength: 200)
- description: (string)
- kind: required(string)
  Allows categorization of materials.
- product_related_ordering: required(boolean)
- billing_mode: required(one of full_sku, actual_consumption)
- unit: required(one of piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- height: (number)
- width: (number)
- depth: (number)
- weight: (number)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

[
{
"id": 2534,
"name": "Lager bei Druckplattenbelichter",
"reference": "C6ND28",
"kind": "shopfloor",
"created_at": "2017-11-28T10:03:43.003+01:00",
"updated_at": "2017-11-28T10:03:43.003+01:00"
},
{
"id": 2538,
"name": "Lager bei HP Indigo 10000",
"reference": "F1NZFS",
"kind": "shopfloor",
"created_at": "2017-11-28T10:28:57.255+01:00",
"updated_at": "2017-11-28T10:28:57.255+01:00"
},
{
"id": 766,
"name": "Farblager",
"reference": "3G88EB",
"kind": "storage",
"created_at": "2016-08-11T19:47:29.899+02:00",
"updated_at": "2017-03-09T11:10:27.211+01:00"
},
{
"id": 739,
"name": "Lager bei Hewlett-Packard Indigo 7800",
"reference": "2GBWT4",
"kind": "shopfloor",
"created_at": "2016-08-08T11:27:57.605+02:00",
"updated_at": "2017-10-11T11:40:27.790+02:00"
},
{
"id": 537,
"name": "Lager bei Hewlett-Packard Indigo 5C",
"reference": "RCDNAM",
"kind": "shopfloor",
"created_at": "2016-05-30T09:33:19.857+02:00",
"updated_at": "2017-02-15T10:53:23.913+01:00"
},
{
"id": 767,
"name": "Papierlager",
"reference": "HDCCG8",
"kind": "storage",
"created_at": "2016-08-11T19:57:08.596+02:00",
"updated_at": "2017-12-14T16:14:45.629+01:00"
}
]

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new StorageArea object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

Body

Media type: application/json

Type: object

Properties

storage_area: required(object)
- name: required(string - minLength: 1 - maxLength: 200)
- kind: required(one of storage, shopfloor, incoming, outgoing, picking)

Example:

{
"storage_area": {
"name": "Super Big Storage Area",
"kind": "storage"
}
}

HTTP status code 201

This response is returned if creating a new StorageArea was successful.

Body

Media type: application/json

Type: object

Properties

name: required(string - minLength: 1 - maxLength: 200)
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
kind: required(one of storage, shopfloor, incoming, outgoing, picking)
materials: (array of object)
Items: Material
- name: required(string - minLength: 1 - maxLength: 200)
- description: (string)
- kind: required(string)
  Allows categorization of materials.
- product_related_ordering: required(boolean)
- billing_mode: required(one of full_sku, actual_consumption)
- unit: required(one of piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- height: (number)
- width: (number)
- depth: (number)
- weight: (number)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 2611,
"name": "Super Big Storage Area",
"reference": "UARBRR",
"kind": "storage",
"created_at": "2017-12-14T19:51:11.113+01:00",
"updated_at": "2017-12-14T19:51:11.113+01:00"
}

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/warehouse/storage_areas/{storage_area_id} get patch delete

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.

Get a single StorageArea record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

storage_area_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

name: required(string - minLength: 1 - maxLength: 200)
reference: required(string - pattern: ^[0-9A-Z]{6}$)
A 6-character, alphanumeric string, that uniquely identifies an object.
Example:
```
N4XTC8
```
kind: required(one of storage, shopfloor, incoming, outgoing, picking)
materials: (array of object)
Items: Material
- name: required(string - minLength: 1 - maxLength: 200)
- description: (string)
- kind: required(string)
  Allows categorization of materials.
- product_related_ordering: required(boolean)
- billing_mode: required(one of full_sku, actual_consumption)
- unit: required(one of piece, plate, sheet, folded_sheet, meter, sqmeter, sqmillimeter, millimeter, liter, milliliter, gram, kilogram, ream)
- height: (number)
- width: (number)
- depth: (number)
- weight: (number)
- created_at: required(datetime)
  The exact time the respective object was created.
- updated_at: required(datetime)
  The exact time the respective object was last updated.
- id: required(integer - minimum: 1)
  Unique identifier for every object. Is used when referencing resources in URLs.
created_at: required(datetime)
The exact time the respective object was created.
updated_at: required(datetime)
The exact time the respective object was last updated.
id: required(integer - minimum: 1)
Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"id": 767,
"name": "Papierlager",
"reference": "HDCCG8",
"kind": "storage",
"created_at": "2016-08-11T19:57:08.596+02:00",
"updated_at": "2017-12-14T16:14:45.629+01:00",
"materials": [
{
  "id": 30583,
  "name": "Multiart Silk Weiß – 880mm × 630mm bei 250 gr/m² (Schmalbahn)",
  "kind": "Papier",
  "unit": "sheet",
  "available": 5550,
  "quantity": 5550
},
{
  "id": 36478,
  "name": "Multiart Silk Weiß – 630mm × 440mm bei 250 gr/m² (Schmalbahn)",
  "kind": "Papier",
  "unit": "sheet",
  "available": 2821,
  "quantity": 2821
},
{
  "id": 36490,
  "name": "Multiart Silk Weiß – 880mm × 630mm bei 150 gr/m² (Schmalbahn)",
  "kind": "Papier",
  "unit": "sheet",
  "available": 39650,
  "quantity": 39650
},
{
  "id": 36512,
  "name": "Multiart Silk Weiß – 880mm × 630mm bei 100 gr/m² (Schmalbahn)",
  "kind": "Papier",
  "unit": "sheet",
  "available": 1800,
  "quantity": 1800
},
{
  "id": 48076,
  "name": "Banderole",
  "kind": "Banderole",
  "unit": "meter",
  "available": 68,
  "quantity": 68
},
{
  "id": 48077,
  "name": "Karton",
  "kind": "Karton",
  "unit": "piece",
  "available": 2000,
  "quantity": 2000
},
{
  "id": 48078,
  "name": "Versandkarton",
  "kind": "Versandkarton",
  "unit": "piece",
  "available": 2000,
  "quantity": 2000
},
{
  "id": 209524,
  "name": "Box - 325 x 220 x 160 mm - (Small)",
  "kind": "Boxes",
  "unit": "piece",
  "available": 1,
  "quantity": 1
}
]
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Update the given StorageArea record with provided data.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

storage_area_id: required(string)

Body

Media type: application/json

Type: object

Properties

storage_area: required(object)
- name: required(string - minLength: 1 - maxLength: 200)
- kind: required(one of storage, shopfloor, incoming, outgoing, picking)

Example:

{
"storage_area": {
"name": "Super Big Storage Area",
"kind": "storage"
}
}

HTTP status code 204

Returned if the record was successfully updated.

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Delete the given StorageArea record.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

storage_area_id: required(string)

HTTP status code 204

Returned if the record was successfully deleted.

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

/warehouse/storage_areas/{storage_area_id}/material_transfers get post

The collection of MaterialTransfers

get

Get a list of all MaterialTransfer objects.

post

Create a new MaterialTransfer object.

Get a list of all MaterialTransfer objects.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

storage_area_id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of MaterialTransfer

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Create a new MaterialTransfer object.

Secured by BearerToken

Keyline requires API users to authenticate before they can access any information.

URI Parameters

storage_area_id: required(string)

Body

Media type: application/json

Type: MaterialTransferRequest

HTTP status code 201

This response is returned if creating a new MaterialTransfer was successful.

Body

Media type: application/json

Type: MaterialTransfer

HTTP status code 422

This response is returned in case the request contained invalid data.

Body

Media type: application/json

Type: object

Properties

errors: required(object)

Example:

{
"errors": {
"name": [
  "is too short (minimum is 1 character)"
]
}
}

Secured by BearerToken

Headers

Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)
Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.
Example:
```
Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885
```

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

Keyline API documentation version 2.0

/accounting

get /accounting/invoices

HTTP status code 200

Body

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403

get /accounting/invoices/{invoice_id}

URI Parameters

HTTP status code 200

Body

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403

get /accounting/customer_invoices

HTTP status code 200

Body

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403

post /accounting/customer_invoices

Body

HTTP status code 201

Body

HTTP status code 422

Body

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403

get /accounting/customer_invoices/{customer_invoice_id}

URI Parameters

HTTP status code 200

Body

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403

patch /accounting/customer_invoices/{customer_invoice_id}

URI Parameters

Body

HTTP status code 204

HTTP status code 422

Body

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403

delete /accounting/customer_invoices/{customer_invoice_id}

URI Parameters

HTTP status code 204

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403

post /accounting/customer_invoices/{customer_invoice_id}/contact

URI Parameters

Body

HTTP status code 201

Body

HTTP status code 422

Body

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403

patch /accounting/customer_invoices/{customer_invoice_id}/contact

URI Parameters

Body

HTTP status code 204

HTTP status code 422

Body

Secured by BearerToken

Headers

HTTP status code 401

HTTP status code 403