Skip to main content

InvoiceResponseDtoViewPage

totalCountinteger<int32>

Number of entries in the returned resultset

Example: 5
previousPagestringnullable

Index of the previous page

Example: 1
nextPagestringnullable

Index of the next page

Example: 3
currentPageinteger<int32>

Index of the current page

Example: 2
entries object[]nullable

Collection of the response DTO model instances.

  • Array [
  • externalInvoiceIdstringrequired

    The internal invoice identifier within your system. Is expected to be unique within the company.

    Possible values: non-empty

    Example: F50015
    invoiceDatestringrequired

    The invoice date (yyyy-MM-dd)

    Possible values: non-empty

    Example: 2022-07-25
    postingDatestringnullable

    Posting date of the invoice (yyyy-MM-dd)

    Example: 2022-07-21
    dueDatestringnullable

    Payment due date (yyyy-MM-dd)

    Example: 2022-08-15
    currencyCodestringnullable

    Three-digit ISO 4217 currency code

    Possible values: >= 3 characters and <= 3 characters

    Example: DKK
    amountExVatnumber<double>required

    Total amount on the invoice not including VAT

    Example: 324
    vatAmountnumber<double>required

    The total VAT amount on the invoice

    Example: 81
    amountInclVatnumber<double>required

    Total amount on the invoice including VAT

    Example: 405
    externalPurchaserIdstringnullable

    Unique identifier of the purchaser within your system. Is expected to be unique within the company.

    Example: MKR
    buyer objectrequired

    Company DTO model.

    externalIdstringnullable

    Unique identifier of the company from your ERP system. Is expected to be unique.

    Example: 1001abc
    namestringnullable

    Represents the name of the company

    Example: Kaunt A/S
    glnNumberstringnullable

    The Global Location Number (GLN) of the company

    Example: 574400338
    taxIdentificationNumberstringnullable

    The Tax Identification number (TIN) the company is registered under.

    Example: 40865888
    address object

    Address DTO model.

    addressstringnullable

    Address

    Example: Fiskerivej 12
    citystringnullable
    Example: Aarhus
    zipCodestringnullable
    Example: 8000
    countryCodestringnullable

    3-letter ISO 3166 country code.

    Example: DNK
    contact object
    namestringnullable

    Contact name

    Example: Lori K. Myrie
    emailAddressstringnullable

    Email address for the contact

    Example: mailtocontact@contact.com
    phoneNumberstringnullable

    Phone number for the contact

    Example: +45 88 88 88 88
    vendor objectrequired

    Company DTO model.

    externalIdstringnullable

    Unique identifier of the company from your ERP system. Is expected to be unique.

    Example: 1001abc
    namestringnullable

    Represents the name of the company

    Example: Kaunt A/S
    glnNumberstringnullable

    The Global Location Number (GLN) of the company

    Example: 574400338
    taxIdentificationNumberstringnullable

    The Tax Identification number (TIN) the company is registered under.

    Example: 40865888
    address object

    Address DTO model.

    addressstringnullable

    Address

    Example: Fiskerivej 12
    citystringnullable
    Example: Aarhus
    zipCodestringnullable
    Example: 8000
    countryCodestringnullable

    3-letter ISO 3166 country code.

    Example: DNK
    contact object
    namestringnullable

    Contact name

    Example: Lori K. Myrie
    emailAddressstringnullable

    Email address for the contact

    Example: mailtocontact@contact.com
    phoneNumberstringnullable

    Phone number for the contact

    Example: +45 88 88 88 88
    deliveryAddress object

    Address DTO model.

    addressstringnullable

    Address

    Example: Fiskerivej 12
    citystringnullable
    Example: Aarhus
    zipCodestringnullable
    Example: 8000
    countryCodestringnullable

    3-letter ISO 3166 country code.

    Example: DNK
    deliveryContact object
    namestringnullable

    Contact name

    Example: Lori K. Myrie
    emailAddressstringnullable

    Email address for the contact

    Example: mailtocontact@contact.com
    phoneNumberstringnullable

    Phone number for the contact

    Example: +45 88 88 88 88
    vendorInvoiceNumberstringnullable

    Invoice id provided by the vendor

    Example: Invoice-EN-175
    orderNumberstringnullable

    The number of the order to which the invoice is associated to

    Example: 999554
    externalApproverIdstringnullable

    Unique identifier of the first approver in the workflow. Is expected to be unique within the company.

    Example: Jack Petterson
    notestringnullable

    Free-form text pertinent to this document, conveying information that is not contained explicitly in other structures.

    Example: EXAMPLE
    paymentInformation object

    Payment information DTO model.

    paymentMethodIdstring

    Identifier of the given payment method

    Example: DirectPayment01
    paymentReferencestringnullable

    The reference of the payment

    Example: T-155
    paymentTermsIdstringnullable

    Identifier for the payment terms

    Example: WithoutVat-5
    bankSwiftCodestringnullable

    Bank swift code

    Example: AAAA-BB-CC-123
    bankIbanNumberstringnullable

    Bank IBAN number

    Example: AA12345678901234567890
    invoiceLines object[]required

    Possible values: >= 1

  • Array [
  • lineNumberstringnullable

    The line sequence number

    Example: 1
    descriptionstringnullable

    Specifies the description of the invoice line

    Example: Macbook Pro 14 inch, 512gb SSD, 16GB RAM, Space Grey
    namestringnullable

    A short name optionally given to this item, such as a name from a catalogue, as distinct from a description

    Example: MACBOOKPRO14-SG
    quantitynumber<double>nullable

    The quantity of the item in the invoice line

    Example: 1
    unitOfMeasurestringnullable

    Unit of measure for the invoice line

    Example: Pcs
    lineAmountExVatnumber<double>required

    The line amount not including VAT

    Example: 108
    lineVatAmountnumber<double>required

    The line VAT amount

    Example: 27
    lineAmountInclVatnumber<double>required

    The line amount including VAT

    Example: 135
  • ]
  • idstring<uuid>

    The unique kaunt identifier of the invoice

    Example: 88af81e1-1e47-4a60-8322-e5854bb6475f
    attachments object[]nullable
  • Array [
  • fileNamestring

    The filename including file ending.

    Example: Invoice001.pdf
    mimeTypestring

    The mimetype/media type of the file

    Example: application/pdf
    urlstring

    URL for downloading the filecontent of the attachment

    Example: https://sandbox-api.kaunt.com/tenants/05ed0ffa-1bf5-4bd1-9970-df7a78a948fe/companies/kaunt/files/d6281ec7-6fd4-4a13-be92-d3bebbcf79f7.pdf
  • ]
  • ]
  • InvoiceResponseDtoViewPage
    {
    "totalCount": 5,
    "previousPage": "1",
    "nextPage": "3",
    "currentPage": 2,
    "entries": [
    {
    "externalInvoiceId": "F50015",
    "invoiceDate": "2022-07-25",
    "postingDate": "2022-07-21",
    "dueDate": "2022-08-15",
    "currencyCode": "DKK",
    "amountExVat": 324,
    "vatAmount": 81,
    "amountInclVat": 405,
    "externalPurchaserId": "MKR",
    "buyer": {
    "externalId": "1001abc",
    "name": "Kaunt A/S",
    "glnNumber": "574400338",
    "taxIdentificationNumber": "40865888",
    "address": {
    "address": "Fiskerivej 12",
    "city": "Aarhus",
    "zipCode": "8000",
    "countryCode": "DNK"
    },
    "contact": {
    "name": "Lori K. Myrie",
    "emailAddress": "mailtocontact@contact.com",
    "phoneNumber": "+45 88 88 88 88"
    }
    },
    "vendor": {
    "externalId": "1001abc",
    "name": "Kaunt A/S",
    "glnNumber": "574400338",
    "taxIdentificationNumber": "40865888",
    "address": {
    "address": "Fiskerivej 12",
    "city": "Aarhus",
    "zipCode": "8000",
    "countryCode": "DNK"
    },
    "contact": {
    "name": "Lori K. Myrie",
    "emailAddress": "mailtocontact@contact.com",
    "phoneNumber": "+45 88 88 88 88"
    }
    },
    "deliveryAddress": {
    "address": "Fiskerivej 12",
    "city": "Aarhus",
    "zipCode": "8000",
    "countryCode": "DNK"
    },
    "deliveryContact": {
    "name": "Lori K. Myrie",
    "emailAddress": "mailtocontact@contact.com",
    "phoneNumber": "+45 88 88 88 88"
    },
    "vendorInvoiceNumber": "Invoice-EN-175",
    "orderNumber": "999554",
    "externalApproverId": "Jack Petterson",
    "note": "EXAMPLE",
    "paymentInformation": {
    "paymentMethodId": "DirectPayment01",
    "paymentReference": "T-155",
    "paymentTermsId": "WithoutVat-5",
    "bankSwiftCode": "AAAA-BB-CC-123",
    "bankIbanNumber": "AA12345678901234567890"
    },
    "invoiceLines": [
    {
    "lineNumber": "1",
    "description": "Macbook Pro 14 inch, 512gb SSD, 16GB RAM, Space Grey",
    "name": "MACBOOKPRO14-SG",
    "quantity": 1,
    "unitOfMeasure": "Pcs",
    "lineAmountExVat": 108,
    "lineVatAmount": 27,
    "lineAmountInclVat": 135
    }
    ],
    "id": "88af81e1-1e47-4a60-8322-e5854bb6475f",
    "attachments": [
    {
    "fileName": "Invoice001.pdf",
    "mimeType": "application/pdf",
    "url": "https://sandbox-api.kaunt.com/tenants/05ed0ffa-1bf5-4bd1-9970-df7a78a948fe/companies/kaunt/files/d6281ec7-6fd4-4a13-be92-d3bebbcf79f7.pdf"
    }
    ]
    }
    ]
    }