GetInvoice

GET

/api/v1/t/{tenant}/finance/invoices/{invoiceId}

curl --request GET \
  --url https://example.com/api/v1/t/example/finance/invoices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Path Parameters

tenant

required

string

Tenant slug

invoiceId

required

string format: uuid

Responses

200

OK

Media typeapplication/json

object

invoiceId

required

string format: uuid

documentId

required

string format: uuid

kind

required

Allowed values: Invoice CreditNote

invoiceNumber

required

null | string

vendorName

required

null | string

invoiceDate

required

null | string format: date

dueDate

required

null | string format: date

documentGross

required

null | number format: double

currency

required

string

vendor

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

null | string

name

required

string

isConfirmed

required

boolean

proposedVendor

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

null | string

name

required

string

isConfirmed

required

boolean

netTotal

required

null | number format: double

taxTotal

required

null | number format: double

hasTotalsMismatch

required

boolean

skontoPercent

required

null | number format: double

skontoDays

required

null | integer format: int32

skontoUntil

required

null | string format: date

factsSource

required

One of:

null

null

unknown

Allowed values: Capture EInvoice Person

taxLines

required

Array<object>

object

rate

required

number format: double

net

required

number format: double

tax

required

number format: double

lines

required

Array<object>

object

position

required

integer format: int32

amount

required

number format: double

glAccount

required

object

id

required

string format: uuid

number

required

string

name

required

string

costCenter

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

string

name

required

string

taxKey

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

string

name

required

string

suggestion

required

One of:

null

null

object

object

costCenter

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

string

name

required

string

glAccount

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

string

name

required

string

taxKey

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

string

name

required

string

basis

required

Allowed values: VendorDefault History

state

required

Allowed values: Open Confirmed Dismissed

createdAt

required

string format: date-time

approvalState

required

Allowed values: Open InApproval Approved Rejected

approvalSource

required

One of:

null

null

unknown

Allowed values: Workflow Person

approvedAt

required

null | string format: date-time

approvedBy

required

null | string format: uuid

exportId

required

null | string format: uuid

isReadOnly

required

boolean

canApproveByHand

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

version

required

integer format: uint32

lastExportReset

required

One of:

null

null

object

object

resetAt

required

string format: date-time

resetBy

required

string format: uuid

reason

required

string

exportedFields

required

One of:

null

null

object

object

exportedAt

required

string format: date-time

invoiceNumber

required

null | string

vendorName

required

null | string

invoiceDate

required

null | string format: date

dueDate

required

null | string format: date

gross

required

null | number format: double

changedSinceExport

required

Array

Allowed values: InvoiceNumber VendorName InvoiceDate DueDate Gross

Example

{
  "kind": "Invoice",
  "factsSource": "Capture",
  "suggestion": {
    "basis": "VendorDefault",
    "state": "Open"
  },
  "approvalState": "Open",
  "approvalSource": "Workflow",
  "changedSinceExport": [
    "InvoiceNumber"
  ]
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}