InvoiceCodingProposalResponseDto

Response model for invoice coding proposal.

idstring<uuid>

The Unique Kaunt Id of the invoice.

Example: 1cca04bf-7def-42ca-a56f-c36becb7c9e4

invoiceLineCodingDimensionProposals object[]

An array containing general dimensions associated to the invoice.

Array [

invoiceLineNumberstringnullablerequired

Sequence number for a coding proposal for a invoice

Example: 1

dimensionProposals object[]

Array of dimensions related to the invoice line. Ordered alphabetically by the dimension name.

Array [

externalDimensionIdstringrequired

The unique identifier of the dimension in your ERP system.

Example: Assurance-155

externalDimensionNamestringnullable

Name of the dimension

Example: Assurance

dimensionValueProposals object[]

Array of coding proposals. Ordered by certainty with the first entry being the proposal with the highest certainty.

Array [

externalDimensionValueIdstringnullable

Identifier of the dimension value in your ERP system. Is expected to be unique within the company.

Example: Assurance01

externalDimensionValueNamestringnullable

Name of the dimension value in your ERP system.

Example: Assurance-155

confidencestring

The confidence level of the proposal.

Possible values: [Low, Medium, High]

proposalPriorityinteger<int32>

Priority index indicating the priority of the proposal. The lowest number indicates the highest priority.

Example: 1

]

invoiceLineCodingDimensionCombinationProposals object[]

An array containing proposals for the combination of dimensions

Array [

invoiceLineNumberstringnullablerequired

Sequence number for a coding proposal for an invoice

Example: 1

dimensionCombinationProposals object[]

Array of proposals for dimension combinations. Ordered by certainty with the first entry being the proposal with the highest certainty.

Array [

confidencestringrequired

The confidence level for the entire combination of dimensions. This represents the confidence that all dimensions in the combination are correct together.

Possible values: [Low, Medium, High]

proposalPriorityinteger<int32>

Priority index indicating the priority of the proposal. The lowest number indicates the highest priority.

Example: 1

dimensionsWithValues object[]

The dimensions with their corresponding values in the proposal.

Array [

externalDimensionIdstringrequired

The unique identifier of the dimension in your ERP system. Is expected to be unique within the company.

Example: Assurance-155

externalDimensionNamestringnullable

Name of the dimension

Example: Assurance

externalDimensionValueIdstringnullable

The unique identifier of the specific value for this dimension. Is expected to be unique within the company.

Example: Assurance01

externalDimensionValueNamestringnullable

The name for the dimension value

Example: Assurance dimension

confidencestringrequired

The confidence level for this individual dimension value. This can differ from the confidence of the entire dimension combination.

Possible values: [Low, Medium, High]

Example: High

]

invoiceCodingProposalGroups object[]nullable

An array containing coding proposals and posting text proposals for the posting groups

Array [

invoiceLineNumbersstring[]

List of invoiceLineNumbers that are part of the posting group proposal

Example: ["1"]

invoiceLineIndexesinteger<int32>[]

Zero-based indexes of the invoice lines that are part of the posting group proposal. The index corresponds to the index of the invoice line in the invoice. Because invoice line numbers are not guaranteed to be unique or present. The index can be used as a reference to the invoice lines.

Example: [0]

postingTextProposals object[]

List of posting text proposals for the posting group

Array [

textstringrequired

Text of the proposal

Example: Freight

proposalPriorityinteger<int32>required

Priority index indicating the priority of the proposal.The lowest number indicates the highest priority.

Example: 1

]

dimensionCombinationProposal object

DTO representing a proposal for a combination of dimension values.

confidencestringrequired

The confidence level for the entire combination of dimensions. This represents the confidence that all dimensions in the combination are correct together.

Possible values: [Low, Medium, High]

proposalPriorityinteger<int32>

Priority index indicating the priority of the proposal. The lowest number indicates the highest priority.

Example: 1

dimensionsWithValues object[]

The dimensions with their corresponding values in the proposal.

Array [

externalDimensionIdstringrequired

The unique identifier of the dimension in your ERP system. Is expected to be unique within the company.

Example: Assurance-155

externalDimensionNamestringnullable

Name of the dimension

Example: Assurance

externalDimensionValueIdstringnullable

The unique identifier of the specific value for this dimension. Is expected to be unique within the company.

Example: Assurance01

externalDimensionValueNamestringnullable

The name for the dimension value

Example: Assurance dimension

confidencestringrequired

The confidence level for this individual dimension value. This can differ from the confidence of the entire dimension combination.

Possible values: [Low, Medium, High]

Example: High

]

amountExVatnumber<double>required

Total amount on the posting group not including VAT

Example: 324

vatAmountnumber<double>required

The total VAT amount on the posting group

Example: 81

amountInclVatnumber<double>required

Total amount on the posting group including VAT

Example: 405

typestringrequired

The type of the posting group (posting or residual).

Possible values: [Posting, Residual]

Example: Posting

accrual object[]

List of accrual proposals for the posting group.

Array [

confidencestringrequired

The confidence level of the accrual proposal.

Possible values: [Low, Medium, High]

Example: High

hasAccrualbooleannullable

Indicates whether the posting group has an accrual. It is possible that HasAccrual is true even though the accrual details are not fully specified.

Example: true

accrualCodestringnullable

The accrual code for the posting group.

Example: 1234

accrualStartDatestring<date-time>nullable

The start date of the accrual period.

Example: 2025-01-01

accrualEndDatestring<date-time>nullable

The end date of the accrual period.

Example: 2026-03-31

]

InvoiceCodingProposalResponseDto
{
  "id": "1cca04bf-7def-42ca-a56f-c36becb7c9e4",
  "invoiceLineCodingDimensionProposals": [
    {
      "invoiceLineNumber": "1",
      "dimensionProposals": [
        {
          "externalDimensionId": "Assurance-155",
          "externalDimensionName": "Assurance",
          "dimensionValueProposals": [
            {
              "externalDimensionValueId": "Assurance01",
              "externalDimensionValueName": "Assurance-155",
              "confidence": "Low",
              "proposalPriority": 1
            }
          ]
        }
      ]
    }
  ],
  "invoiceLineCodingDimensionCombinationProposals": [
    {
      "invoiceLineNumber": "1",
      "dimensionCombinationProposals": [
        {
          "confidence": "Low",
          "proposalPriority": 1,
          "dimensionsWithValues": [
            {
              "externalDimensionId": "Assurance-155",
              "externalDimensionName": "Assurance",
              "externalDimensionValueId": "Assurance01",
              "externalDimensionValueName": "Assurance dimension",
              "confidence": "High"
            }
          ]
        }
      ]
    }
  ],
  "invoiceCodingProposalGroups": [
    {
      "invoiceLineNumbers": [
        "1"
      ],
      "invoiceLineIndexes": [
        0
      ],
      "postingTextProposals": [
        {
          "text": "Freight",
          "proposalPriority": 1
        }
      ],
      "dimensionCombinationProposal": {
        "confidence": "Low",
        "proposalPriority": 1,
        "dimensionsWithValues": [
          {
            "externalDimensionId": "Assurance-155",
            "externalDimensionName": "Assurance",
            "externalDimensionValueId": "Assurance01",
            "externalDimensionValueName": "Assurance dimension",
            "confidence": "High"
          }
        ]
      },
      "amountExVat": 324,
      "vatAmount": 81,
      "amountInclVat": 405,
      "type": "Posting",
      "accrual": [
        {
          "confidence": "High",
          "hasAccrual": true,
          "accrualCode": "1234",
          "accrualStartDate": "2025-01-01",
          "accrualEndDate": "2026-03-31"
        }
      ]
    }
  ]
}