BObokio
supplier-invoices

Get supplier invoices

Changed on

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

Scope: supplier-invoices:read

get/companies/{companyId}/supplier-invoices

Request

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

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

projectIdstring uuid

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

querystring

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

FieldType
supplierRef.idstring
invoiceNumberstring
totalAmountnumber
currencystring
invoiceDatedate
dueDatedate

Response

Supplier invoices found

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "6f6b2f17-3c4a-4a69-9f2d-3f5d7e1b8c90",
      "supplierRef": {
        "id": "6f6b2f17-3c4a-4a69-9f2d-3f5d7e1b8c90",
        "name": "Supplier AB"
      },
      "invoiceNumber": "INV-001",
      "invoiceDate": "2023-10-01",
      "dueDate": "2023-10-15",
      "totalAmount": 1000,
      "remainingAmount": 1000,
      "currency": "SEK",
      "currencyRate": 1,
      "journalEntryRef": {
        "id": "2d8ce6b4-1f3a-46a5-8a9d-5b7f2c4e9d10"
      },
      "lineItems": [
        {
          "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "description": "Consulting",
          "quantity": 10,
          "unitPrice": 1000,
          "unitType": "hour",
          "taxRate": 25,
          "projectRef": {
            "id": "4f8f6da6-4cbc-4bfc-8d23-67d5f6f2dd9b",
            "projectName": "Website Redesign",
            "projectNumber": "P-001"
          },
          "costCenterRef": {
            "tagId": "7e5ee25f-1f5d-4e47-a26f-5d2d20fbef90",
            "tagName": "Nord"
          }
        }
      ],
      "uploadRefs": [
        {
          "id": "24f3b7c1-8d6a-4e2f-9b31-5d7c2a8e4f90"
        },
        {
          "id": "34e1c9a5-7b2d-4f86-8a31-6d2c5f9b7e40"
        }
      ]
    }
  ]
}

Changes

  • 9395020f3da2Revision changes
    • info

      added the new optional query request parameter projectId

    • info

      added the non-success response with the status

    • info

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