Read a canonical invoice

GET

/invoices/{invoiceId}

curl --request GET \
  --url https://api.invogi.com/v1/invoices/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth

Parameters

Path Parameters

invoiceId

required

string

Responses

200

Invoice

Media typeapplication/json

object

id

required

string format: uuid

invoiceNumber

required

string

issueDate

required

string format: date

dueDate

required

string | null format: date

currency

required

string

>= 3 characters <= 3 characters

netAmount

required

One of:

string

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

null

null

taxAmount

required

One of:

string

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

null

null

grossAmount

required

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

purchaseOrderRef

required

string | null

processingStatus

required

string

Allowed values: UPLOADED EXTRACTING NORMALIZING ANALYZING COMPLETE FAILED

scanId

required

Source historical scan; null for real-time invoices

string | null format: uuid

supplierId

required

string | null format: uuid

supplierName

required

string | null

supplierTaxId

required

string | null

companyId

required

string format: uuid

companyName

required

string

companySource

required

How an invoice’s company was chosen. BUYER_UNMATCHED: the buyer VAT ID matched no company, so the invoice fell back to the default company and awaits confirmation or a move.

string

Allowed values: EXPLICIT ERP BUYER_MATCH BUYER_UNMATCHED DEFAULT

companyVatId

required

VAT ID of the invoice’s company

string | null

companyIsDefault

required

boolean

buyerName

required

Buyer name as stated on the invoice (EN 16931 BT-44)

string | null

buyerVatId

required

Buyer VAT ID as stated on the invoice (BT-48)

string | null

createdAt

required

string format: date-time

decision

required

One of:

string

string

Allowed values: PASS REVIEW BLOCK

null

null

fx

required

One of:

object

object

baseCurrency

required

The organization’s base currency when the invoice was analysed

string

>= 3 characters <= 3 characters

rate

required

Units of baseCurrency per one unit of the invoice currency, to 14 decimal places

string

rateDate

required

Reference date the rate was published for: the last business day on or before the issue date

string format: date

source

required

ECB (European Central Bank reference rate), ECB+PEG (derived through a fixed central-bank parity such as AED/USD), or IDENTITY (invoice already in the base currency)

string

grossAmountBase

required

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

null

null

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

Position as received; not assumed numeric or contiguous

string | null

description

required

string | null

quantity

required

Decimal string

string | null

unitPrice

required

Decimal string

string | null

taxRate

required

Decimal string

string | null

lineNetAmount

required

Decimal string

string | null

findings

required

Array<object>

object

id

required

string format: uuid

invoiceId

required

string format: uuid

invoiceNumber

required

string

supplierId

required

string | null format: uuid

supplierName

required

string | null

scanId

required

Source historical scan; null for real-time invoices

string | null format: uuid

type

required

string

severity

required

string

Allowed values: INFO LOW MEDIUM HIGH CRITICAL

confidence

required

Decimal string between 0 and 1

string | null

summary

required

string

recommendedAction

required

Concrete next step generated by the deterministic control

string | null

evidence

required

object

key

additional properties

any

relatedInvoiceIds

required

Array<string>

disposition

required

string

Allowed values: OPEN CONFIRMED FALSE_POSITIVE ACCEPTED_RISK

createdAt

required

string format: date-time

sourceDocument

required

One of:

object

object

id

required

string format: uuid

mediaType

required

string

Allowed values: application/pdf application/xml text/xml image/png image/jpeg image/tiff

byteSize

required

integer

>= 1

pageCount

required

integer | null

createdAt

required

string format: date-time

deletedAt

required

string | null format: date-time

structuredFormat

Present on invoice detail when the source is a recognized FA(3) XML document

string | null

Allowed values: KSEF

null

null

Example

{
  "processingStatus": "UPLOADED",
  "companySource": "EXPLICIT",
  "decision": "PASS",
  "findings": [
    {
      "severity": "INFO",
      "disposition": "OPEN"
    }
  ],
  "sourceDocument": {
    "mediaType": "application/pdf",
    "structuredFormat": "KSEF"
  }
}

401

Missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

404

Resource not found

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}