SuccessResultDocumentErrorResultDocumentBatchResultSuccessResultResponse

Wraps a successful API response with the result payload.

correlationIduuid

A unique ID of the request

Example: fb0ccbbc-62bc-447f-a47e-02b490e25690

isSuccessboolean

Indicates whether the request was successful. Always true for success responses.

Example: true

result object

Represents the result of a batch operation, containing both succeeded and failed items.

succeeded object[]

The items that were processed successfully.

Array [

iduuid

The unique identifier of the created resource.

linkstringnullable

The URL link to access the created resource.

inputIndexint32

statusCodeint32

externalInvoiceIdstringnullable

The external invoice identifier from the request.

documentExtractionInfo object

Information about the document extraction request. This is only set if Kaunt Document AI is used as the document extraction service.

documentIdstringrequired

The Document AI Document ID for the sent document

extractionUrlstringrequired

The URL to check the status of the document extraction request

]

failed object[]

The items that failed during processing.

Array [

errorstringnullable

The error message describing why the operation failed.

inputIndexint32

statusCodeint32

externalInvoiceIdstringnullable

The external invoice identifier from the request.

]

SuccessResultDocumentErrorResultDocumentBatchResultSuccessResultResponse

{
  "correlationId": "fb0ccbbc-62bc-447f-a47e-02b490e25690",
  "isSuccess": true,
  "result": {
    "succeeded": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "link": "string",
        "inputIndex": 0,
        "statusCode": 0,
        "externalInvoiceId": "string",
        "documentExtractionInfo": {
          "documentId": "string",
          "extractionUrl": "string"
        }
      }
    ],
    "failed": [
      {
        "error": "string",
        "inputIndex": 0,
        "statusCode": 0,
        "externalInvoiceId": "string"
      }
    ]
  }
}