BObokio
customers

Get customers

Changed on

Get all customers for the company. Use the query parameters to filter and navigate through the results. Customers are returned in descending customer-number order: alphanumeric values first, followed by purely numeric values in descending numeric order. Scope: customers:read

get/companies/{companyId}/customers

Request

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

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

querystring

Optional query to filter the data set with supported fields listed below and available operations.

FieldType
namestring
customerNumberstring
typestring
vatNumberstring
orgNumberstring
modifiedDateTimedate-time

Response

Customers found

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "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 optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status