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.

HTTP status code 201

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

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

  • 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_category_id": null,
            "environmental_certifications": []
        }
    ]
}

HTTP status code 422

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

Body

Media type: application/json

Type: object

• 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.

HTTP status code 200

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

  • 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_category_id": null,
            "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.

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

• 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.

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.

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

• 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.

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

• 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.

HTTP status code 201

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

Body

Media type: application/json

Type: 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, 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

• 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.

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

• 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.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: LineItem

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_category_id": null,
      "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_category_id": null,
      "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_category_id": null,
      "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.

HTTP status code 201

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

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

  Unique identifier for every object. Is used when referencing resources in URLs.

• 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_category_id": null,
  "environmental_certifications": []
}

HTTP status code 422

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

Body

Media type: application/json

Type: object

• 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.

HTTP status code 200

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

  Unique identifier for every object. Is used when referencing resources in URLs.

• 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_category_id": null,
  "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.

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

• 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.

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.

HTTP status code 201

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

Body

Media type: application/json

Type: object

• 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

• 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.

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

• 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.

HTTP status code 201

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

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

  • 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_category_id": null,
          "environmental_certifications": []
      }
  ]
}

HTTP status code 422

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

Body

Media type: application/json

Type: object

• 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.

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.

HTTP status code 201

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

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

  • 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_category_id": null,
          "environmental_certifications": []
      }
  ]
}

HTTP status code 422

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

Body

Media type: application/json

Type: object

• 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.

HTTP status code 200

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

  • 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_category_id": null,
          "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.

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

• 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.

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.

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

• 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.

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

• 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.

HTTP status code 201

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

Body

Media type: application/json

Type: 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, 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

• 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.

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

• 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.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: LineItem

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_category_id": null,
      "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.

HTTP status code 201

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

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

  Unique identifier for every object. Is used when referencing resources in URLs.

• 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_category_id": null,
  "environmental_certifications": []
}

HTTP status code 422

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

Body

Media type: application/json

Type: object

• 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.

HTTP status code 200

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

  Unique identifier for every object. Is used when referencing resources in URLs.

• 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_category_id": null,
  "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.

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

• 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.

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.

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.

HTTP status code 200

Body

Media type: application/json

Type: object

• 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_id: required (integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

  • 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_category_id": null,
          "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.

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.

HTTP status code 201

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

Body

Media type: application/json

Type: object

• 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

• 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.

HTTP status code 200

Body

Media type: application/json

Type: object

• 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.

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

• 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.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Person

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.

HTTP status code 201

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

Body

Media type: application/json

Type: object

• 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

• 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.

HTTP status code 200

Body

Media type: application/json

Type: object

• 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.

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

• 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.

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.

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.

HTTP status code 200

Body

Media type: application/json

Type: object

• 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.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Carrier

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.

HTTP status code 201

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

Body

Media type: application/json

Type: 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.

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

• 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.

HTTP status code 200

Body

Media type: application/json

Type: 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.

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.

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

• 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.

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.