BObokio
invoices

Get invoices

Changed on

Get all invoices for the company. Use the query parameters to filter and navigate through the results.

Tax reduction: Personal numbers in taxReduction.deductionPeople have the last 4 digits masked when the invoice was created by a different integration. Masked values are returned as YYYYMMDD-XXXX.

Scope: invoices:read

get/companies/{companyId}/invoices

Request

  • Base URL
    https://api.bokio.se/v1
  • URL
    https://api.bokio.se/v1/companies/{companyId}/invoices
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /authorize
      Client credentials
      Token URL: /token scopes: invoices:read

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

projectIdstring uuid

Return only invoices with at least one line item assigned to this project. When combined with query, both filters must match the invoice.

querystring

Optional query to filter the data set with supported fields listed below and available operations. View documentation for filtering on metadata here.

FieldType
typestring
customerRef.iduuid
customerRef.customerNumberstring
orderNumberReferencestring
projectReferencestring
buyerReferencestring
contractReferencestring
currencystring
totalAmountnumber
statusstring
invoiceDatedate
dueDatedate
metadatastring

Response

Invoices found

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "customerRef": {
        "id": "d4e5f6a7-b8c9-0123-def1-234567890123",
        "name": "Acme AB",
        "customerNumber": "CUST-001"
      },
      "lineItems": [
        {
          "id": 1,
          "itemRef": {
            "id": "55c899c5-82b2-47fa-9c51-e35fc9b26443",
            "description": "Installation work"
          },
          "description": "Installation work",
          "itemType": "salesItem",
          "productType": "services",
          "unitType": "custom",
          "customUnitType": "session",
          "quantity": 10,
          "unitPrice": 500,
          "taxRate": 25,
          "bookkeepingAccountNumber": 3389,
          "discount": {
            "type": "percentage",
            "value": 10
          },
          "reverseChargeType": "construction",
          "projectRef": {
            "id": "4f8f6da6-4cbc-4bfc-8d23-67d5f6f2dd9b",
            "projectName": "Website Redesign",
            "projectNumber": "P-001"
          },
          "costCenterRef": {
            "tagId": "7e5ee25f-1f5d-4e47-a26f-5d2d20fbef90",
            "tagName": "Nord"
          }
        }
      ],
      "billingAddress": {
        "line1": "10 Downing Street",
        "line2": null,
        "city": "London",
        "postalCode": "SW1A 2AA",
        "country": "GB",
        "countrySubdivision": "ENG"
      },
      "deliveryAddress": {
        "line1": "Älvsborgsvägen 10",
        "line2": null,
        "city": "Göteborg",
        "postalCode": "123 45",
        "country": "SE"
      },
      "taxReduction": {
        "type": "rot",
        "description": "Bathroom renovation",
        "propertyType": "housingDesignation",
        "tenantOrgNumber": "7164009068",
        "apartmentNumber": "1001",
        "deductionAmount": 1500,
        "status": "draft",
        "deductionPeople": [
          {
            "personalNumber": "19850101-1234",
            "deductionAmount": 1500
          }
        ]
      },
      "metadata": {
        "project": "Website Redesign",
        "department": "IT",
        "externalId": "EXT-INV-2024-001"
      }
    }
  ]
}

Changes

  • 9395020f3da2Revision changes
    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      added the new custom enum value to the /////// response property for the response status

    • info

      added the new optional query request parameter projectId

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added to the /// response property allOf list for the response status