BObokio
customers

Create a customer

Changed on

Creates a customer for the company.

Scope: customers:write

If customerNumber is omitted or null, the next numeric customer number is suggested automatically. A supplied customer number is preserved exactly.

post/companies/{companyId}/customers

Request

  • Base URL
    https://api.bokio.se/v1
  • URL
    https://api.bokio.se/v1/companies/{companyId}/customers
  • Auth
    HTTP bearer

Request body

idstring uuid
namestring required
customerNumberstring nullable

Customer number. On create, omitting this field or setting it to null automatically suggests the next numeric value. On update, omitting this field or setting it to null preserves the existing value. Supplied values are preserved exactly.

type'company' | 'private' required
vatNumberstring
orgNumberstring
paymentTermsstring

Payment terms for the invoices. Payment terms can both take free text or days, in digits, until the payment is due.

On the invoice, if a digit is provided it will be suffixed with "days". For example, "30" will be displayed as "30 days" on the invoice. Note that the suffix will, similar to the rest of the invoice, use the language on the customer.

language'sv' | 'en'

Default 'sv'

constructionReverseChargeEnabledboolean

Whether invoices for this customer may use construction reverse charge.

This can only be enabled when the customer is a Swedish company. Defaults to false.

modifiedDateTimestring date-time nullable

The date and time the customer was last modified. Returns null for customers that were changed before this field was introduced.

Example request

{
  "id": "55c899c5-82b2-47fa-9c51-e35fc9b26443",
  "name": "customer 1",
  "customerNumber": "CUST-001",
  "type": "company",
  "vatNumber": "SE1234567890",
  "orgNumber": "123456-7890",
  "paymentTerms": "30",
  "contactsDetails": [
    {
      "name": "John Doe",
      "email": "john@email.com",
      "phone": "0927-5631505",
      "isDefault": true
    }
  ],
  "address": {
    "line1": "Älvsborgsvägen 10",
    "line2": null,
    "city": "Göteborg",
    "postalCode": "123 45",
    "country": "SE"
  },
  "language": "sv",
  "constructionReverseChargeEnabled": true,
  "modifiedDateTime": "2024-10-10T00:00:00Z"
}

Response

Customer created

idstring uuid
namestring required
customerNumberstring nullable

Customer number. On create, omitting this field or setting it to null automatically suggests the next numeric value. On update, omitting this field or setting it to null preserves the existing value. Supplied values are preserved exactly.

type'company' | 'private' required
vatNumberstring
orgNumberstring
paymentTermsstring

Payment terms for the invoices. Payment terms can both take free text or days, in digits, until the payment is due.

On the invoice, if a digit is provided it will be suffixed with "days". For example, "30" will be displayed as "30 days" on the invoice. Note that the suffix will, similar to the rest of the invoice, use the language on the customer.

language'sv' | 'en'

Default 'sv'

constructionReverseChargeEnabledboolean

Whether invoices for this customer may use construction reverse charge.

This can only be enabled when the customer is a Swedish company. Defaults to false.

modifiedDateTimestring date-time nullable

The date and time the customer was last modified. Returns null for customers that were changed before this field was introduced.

Example response

{
  "id": "55c899c5-82b2-47fa-9c51-e35fc9b26443",
  "name": "customer 1",
  "customerNumber": "CUST-001",
  "type": "company",
  "vatNumber": "SE1234567890",
  "orgNumber": "123456-7890",
  "paymentTerms": "30",
  "contactsDetails": [
    {
      "name": "John Doe",
      "email": "john@email.com",
      "phone": "0927-5631505",
      "isDefault": true
    }
  ],
  "address": {
    "line1": "Älvsborgsvägen 10",
    "line2": null,
    "city": "Göteborg",
    "postalCode": "123 45",
    "country": "SE"
  },
  "language": "sv",
  "constructionReverseChargeEnabled": true,
  "modifiedDateTime": "2024-10-10T00:00:00Z"
}

Changes

  • 9395020f3da2Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status