Sign in

v1

latestOpenAPI 3.0.32026-07-268955212.1 KB
invoices

Get an invoice

Retrieve the information of the invoice with the matching invoiceId.

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/{invoiceId}

Response

Invoice found

idstring uuid
type'invoice' | 'cashInvoice'

The type of the invoice can be invoice or cashInvoice. Can only be set to invoice when creating a new invoice and will default to invoice if not set.

invoiceNumberstring nullable

The invoice number will be generated at the time of publishing the invoice.

paymentReferencestring nullable

The payment reference (OCR number) for the invoice. Populated when the invoice is published, null for drafts.

orderNumberReferencestring nullable

The order number associated with the invoice.

projectReferencestring nullable

The project reference associated with the invoice.

buyerReferencestring nullable

The buyer reference associated with the invoice.

contractReferencestring nullable

The contract reference associated with the invoice.

currencystring

ISO 4217 currency code

currencyRatenumber double
totalAmountnumber double
totalTaxnumber double
paidAmountnumber double
status'draft' | 'published' | 'paid' | 'overPaid' | 'underPaid' | 'overdue' | 'credited' | 'credit'
invoiceDatestring date required
dueDatestring date

The due date for the invoice. Optional — when omitted, it is automatically calculated using the fallback chain: customer payment terms → company payment terms → 30 days from the invoice date.

publishedDateTimestring date-time nullable

The date when the credit note was published (null for draft)

metadataobject

Metadata fields for the invoice as string key-value pairs. These fields can be used for filtering.All metadata keys must start with a letter or underscore and contain only alphanumeric characters and underscores.

Example response

{
  "id": "a419cf69-db6f-4de9-992c-b1a60942a443",
  "type": "invoice",
  "customerRef": {
    "id": "55c899c5-82b2-47fa-9c51-e35fc9b26443",
    "name": "customer 1"
  },
  "contactDetailRef": {
    "id": "d3b07384-d9a0-4c9b-8b3a-6e1f2a5c8d4e",
    "email": "contact@customer1.com",
    "phone": "+46701234567"
  },
  "invoiceNumber": "1234",
  "paymentReference": null,
  "orderNumberReference": "ORD-5678",
  "projectReference": "PROJ-001",
  "buyerReference": "BUYER-123",
  "contractReference": "CONTRACT-456",
  "currency": "SEK",
  "currencyRate": 1,
  "totalAmount": 10000,
  "totalTax": 2500,
  "paidAmount": 0,
  "status": "draft",
  "invoiceDate": "2024-10-10",
  "dueDate": "2024-10-10",
  "lineItems": [
    {
      "id": 1,
      "itemRef": {
        "id": "55c899c5-82b2-47fa-9c51-e35fc9b26443",
        "description": "Product 1"
      },
      "description": "Product 1",
      "itemType": "salesItem",
      "productType": "goods",
      "unitType": "piece",
      "quantity": 1,
      "unitPrice": 5000,
      "taxRate": 25
    },
    {
      "id": 2,
      "description": "Installation work",
      "itemType": "salesItem",
      "productType": "services",
      "unitType": "hour",
      "quantity": 10,
      "unitPrice": 500,
      "taxRate": 25,
      "taxReduction": {
        "taxReductionType": "rot",
        "jobType": "rotConstruction"
      }
    },
    {
      "id": 3,
      "itemRef": {
        "id": "e964435e-50ef-4524-a439-05ff87794952",
        "description": "A description line"
      },
      "description": "A description line",
      "itemType": "descriptionOnlyItem"
    }
  ],
  "billingAddress": {
    "line1": "Älvsborgsvägen 10",
    "line2": null,
    "city": "Göteborg",
    "postalCode": "123 45",
    "country": "SE"
  },
  "deliveryAddress": {
    "line1": "Delivery Street 15",
    "line2": "Floor 2",
    "city": "Stockholm",
    "postalCode": "111 11",
    "country": "SE"
  },
  "taxReduction": {
    "type": "rot",
    "description": "Bathroom renovation",
    "propertyType": "realEstate",
    "realEstateNumber": "STOCKHOLM SÖDER 1:2",
    "deductionAmount": 1500,
    "status": "draft",
    "deductionPeople": [
      {
        "personalNumber": "19850101-1234",
        "deductionAmount": 1500
      }
    ]
  },
  "attachmentRefs": [
    {
      "id": "240a4af0-edfd-47b1-b4ab-f30450eaac19",
      "fileName": "myfile.pdf"
    },
    {
      "id": "94a8f806-8493-40f6-9d5b-0495c84f8ab9",
      "fileName": "myfile2.pdf"
    }
  ],
  "journalEntryRef": {
    "id": "f329df79-eb7f-5ef0-a8dc-c2b71f953554"
  },
  "metadata": {
    "project": "Website Redesign",
    "department": "IT",
    "externalId": "EXT-INV-2024-001"
  }
}