Zum Inhalt springen
AcrivaDocs

ListInvoices

GET
/api/v1/t/{tenant}/finance/invoices
curl --request GET \
  --url 'https://example.com/api/v1/t/example/finance/invoices?tab=All&sort=InvoiceDateNewest' \
  --header 'Authorization: Bearer <token>'

Authorizations

Abschnitt betitelt „Authorizations“

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

Query Parameters

Abschnitt betitelt „Query Parameters“
tab
Allowed values: All Open InApproval Approved Exported Rejected
q
string
vendorId
string format: uuid
costCenterId
string format: uuid
dueFrom
string format: date
dueTo
string format: date
sort
Allowed values: InvoiceDateNewest InvoiceDateOldest DueDateSoonest GrossHighest GrossLowest
cursor
string
limit
integer format: int32

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
object
items
required
Array<object>
object
invoiceId
required
string format: uuid
documentId
required
string format: uuid
kind
required
Allowed values: Invoice CreditNote
vendorId
required
null | string format: uuid
vendorName
required
null | string
invoiceNumber
required
null | string
invoiceDate
required
null | string format: date
dueDate
required
null | string format: date
skontoUntil
required
null | string format: date
skontoPercent
required
null | number format: double
gross
required
null | number format: double
currency
required
string
costCenter
required
One of:
null
approvalState
required
Allowed values: Open InApproval Approved Rejected
isExported
required
boolean
exportId
required
null | string format: uuid
isOverdue
required
boolean
isSkontoEndingSoon
required
boolean
hasTotalsMismatch
required
boolean
hasAllocation
required
boolean
version
required
integer format: uint32
changedSinceExport
required
boolean
nextCursor
required
null | string
total
required
integer format: int32
isTotalCapped
required
boolean
tabCounts
required
object
all
required
integer format: int32
open
required
integer format: int32
inApproval
required
integer format: int32
approved
required
integer format: int32
exported
required
integer format: int32
rejected
required
integer format: int32
sums
required
object
count
required
integer format: int32
gross
required
number format: double
openCount
required
integer format: int32
openGross
required
number format: double
skontoAvailable
required
number format: double
skontoNextUntil
required
null | string format: date
facets
required
object
vendors
required
Array<object>
object
id
required
string format: uuid
label
required
string
count
required
integer format: int32
costCenters
required
Array<object>
object
id
required
string format: uuid
label
required
string
count
required
integer format: int32
Example
{
  "items": [
    {
      "kind": "Invoice",
      "approvalState": "Open"
    }
  ]
}

400

Abschnitt betitelt „400“

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Abschnitt betitelt „403“

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Abschnitt betitelt „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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}