Skip to main content
GET
/
v1
/
invoice
/
{id}
Get invoice
curl --request GET \
  --url http://localhost:3001/v1/invoice/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "originalFileName": "<string>",
  "filename": "<string>",
  "counterpartyName": "<string>",
  "counterpartyIban": "<string>",
  "counterpartyVat": "<string>",
  "counterparty": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "markedTrusted": true,
    "markedTrustedDate": "2023-11-07T05:31:56Z",
    "markedTrustedUser": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "name": "<string>",
      "authId": "<string>",
      "role": "<string>",
      "hasPushNotification": true
    },
    "description": "<string>",
    "vat": "<string>",
    "accountsPayableNumber": "22 0391919",
    "paymentTermsDays": 123,
    "skontoPercentage": 123,
    "skontoDays": 123,
    "bankAccount": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "iban": "<string>",
      "bic": "<string>",
      "countryCode": "<string>",
      "address": "<string>"
    }
  },
  "invoiceNumber": "<string>",
  "internalInvoiceNumber": "<string>",
  "purchaseOrderNumber": "<string>",
  "purchaseOrder": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "purchaseOrderNumber": "<string>",
    "externalId": "<string>",
    "orderDate": "2023-11-07T05:31:56Z",
    "deliveryDate": "2023-11-07T05:31:56Z",
    "counterparty": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "name": "<string>",
      "markedTrusted": true,
      "markedTrustedDate": "2023-11-07T05:31:56Z",
      "markedTrustedUser": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "name": "<string>",
        "authId": "<string>",
        "role": "<string>",
        "hasPushNotification": true,
        "organization": {
          "id": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "name": "<any>",
          "slug": "<any>",
          "logoFileName": "<any>",
          "country": "<any>",
          "vatNumber": "<any>",
          "featureFlags": "<any>"
        }
      },
      "description": "<string>",
      "vat": "<string>",
      "accountsPayableNumber": "22 0391919",
      "street": "<string>",
      "city": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "paymentTermsDays": 123,
      "skontoPercentage": 123,
      "skontoDays": 123,
      "organization": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "slug": "<string>",
        "logoFileName": "<string>",
        "country": "<string>",
        "vatNumber": "<string>",
        "featureFlags": [
          {
            "id": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "featureName": "<any>",
            "isEnabled": "<any>"
          }
        ]
      },
      "bankAccount": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>"
      },
      "bankAccountVerification": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "bankAccount": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>"
        },
        "paymentProvider": "<string>",
        "status": "VALID",
        "initializedAt": "2023-11-07T05:31:56Z",
        "mailTrackings": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "version": 123,
          "type": "ONBOARDING",
          "status": "ACCEPTED"
        },
        "fullName": "<string>"
      },
      "transactions": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "amount": 123,
        "remittanceInformation": "<string>",
        "requestedExecutionDate": "2023-11-07T05:31:56Z",
        "skontoAmount": 123,
        "skontoDate": "2023-11-07T05:31:56Z",
        "ignoreSkontoDeadline": true,
        "creditor": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>"
        },
        "debitor": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>"
        },
        "analysis": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "analysisRules": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "type": "AMOUNT_DEVIATION",
            "severity": "NORMAL",
            "markedOk": true,
            "markedOkReason": "<string>",
            "markedOkDate": "2023-11-07T05:31:56Z",
            "value": "<string>",
            "markedOkUser": "<any>"
          },
          "customRules": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "description": "<string>",
            "rule": "<string>",
            "twoFactorCheck": true,
            "accountCheck": true,
            "deleted": true,
            "active": true,
            "organization": "<any>"
          }
        },
        "archived": true,
        "archivedDate": "2023-11-07T05:31:56Z",
        "archivedByUser": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "name": "<string>",
          "authId": "<string>",
          "role": "<string>",
          "hasPushNotification": true,
          "organization": {
            "id": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "name": "<any>",
            "slug": "<any>",
            "logoFileName": "<any>",
            "country": "<any>",
            "vatNumber": "<any>",
            "featureFlags": "<any>"
          }
        },
        "paymentRun": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "createdById": "<string>",
          "createdByName": "<string>",
          "organizationId": "<string>",
          "sumAmount": 123,
          "sumAmountWithSkonto": 123,
          "sumBookedAmount": 123,
          "transactionCount": 123
        }
      }
    },
    "lineItems": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "productCode": 123,
        "externalId": "<string>",
        "title": "<string>",
        "description": "<string>",
        "quantity": 123,
        "unit": 123,
        "unitPrice": 123,
        "totalPrice": 123,
        "discount": 123,
        "taxRate": 123,
        "taxAmount": 123,
        "deliveredQuantity": 123,
        "invoicedQuantity": 123,
        "invoicedTotalAmount": 123,
        "deliveryPercentage": 123,
        "invoicedPercentage": 123
      }
    ],
    "currency": "<string>",
    "counterpartyId": "<string>",
    "counterpartyName": "<string>",
    "totalOrderAmount": 123,
    "totalInvoicedAmount": 123,
    "totalLineItems": 123,
    "fullyInvoicedLineItemsCount": 123,
    "fullyDeliveredLineItemsCount": 123,
    "invoiceCompletionPercentage": 123,
    "totalOrderQuantity": 123,
    "totalDeliveredQuantity": 123,
    "uniqueDeliveriesCount": 123,
    "totalInvoicedQuantity": 123,
    "uniqueInvoicesCount": 123,
    "outstandingInvoiceAmount": 123
  },
  "date": "<string>",
  "billingPeriodStart": "<string>",
  "billingPeriodEnd": "<string>",
  "dueDate": "<string>",
  "skontoDate": "<string>",
  "skontoAmount": 123,
  "skontoRate": 123,
  "totalAmount": 123,
  "currency": "EUR",
  "type": "INVOICE",
  "paymentTerms": "<string>",
  "notes": "<string>",
  "shouldCreateTransaction": true,
  "alreadyPaid": false,
  "alreadyPaidDate": "<string>",
  "archived": false,
  "archivedDate": "<string>",
  "archivedByUser": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "name": "<string>",
    "authId": "<string>",
    "role": "<string>",
    "hasPushNotification": true
  },
  "organization": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "slug": "<string>",
    "logoFileName": "<string>",
    "country": "<string>",
    "vatNumber": "<string>",
    "featureFlags": [
      {
        "id": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<any>",
        "featureName": "<any>",
        "isEnabled": "<any>"
      }
    ]
  },
  "status": "NEW",
  "debitor": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "iban": "<string>",
    "bic": "<string>",
    "countryCode": "<string>",
    "address": "<string>"
  },
  "export": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "invoiceCount": 123
  },
  "splits": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "partialAmount": 123,
      "taxRate": 123,
      "taxKey": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "type": "SALE",
        "name": "<string>",
        "description": "<string>",
        "internalTaxKeyName": "<string>",
        "externalCode": "<string>",
        "isSystemKey": true
      },
      "notes": "<string>",
      "costCenter": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "code": "<string>",
        "name": "<string>",
        "type": "<string>"
      },
      "costCenter2": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "code": "<string>",
        "name": "<string>",
        "type": "<string>"
      },
      "ledgerAccount": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "accountNumber": "<string>",
        "name": "<string>"
      }
    }
  ],
  "lineItems": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "productCode": 123,
      "externalId": "<string>",
      "title": "<string>",
      "description": "<string>",
      "quantity": 123,
      "unit": 123,
      "unitPrice": 123,
      "totalPrice": 123,
      "discount": 123,
      "taxRate": 123,
      "taxAmount": 123,
      "purchaseOrderLineItem": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "productCode": 123,
        "externalId": "<string>",
        "title": "<string>",
        "description": "<string>",
        "quantity": 123,
        "unit": 123,
        "unitPrice": 123,
        "totalPrice": 123,
        "discount": 123,
        "taxRate": 123,
        "taxAmount": 123,
        "deliveredQuantity": 123,
        "invoicedQuantity": 123,
        "invoicedTotalAmount": 123,
        "deliveryPercentage": 123,
        "invoicedPercentage": 123
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Invoice ID

Response

200 - application/json
currency
enum<string>
default:EUR
required

Currency code for invoice amounts (e.g., EUR, USD).

Available options:
EUR,
USD,
GBP,
JPY,
AUD,
CAD,
CHF,
CNY,
HKD,
NZD,
SEK,
KRW,
SGD,
NOK,
MXN,
INR,
BRL,
RUB,
ZAR,
TRY,
AED,
THB,
DKK,
PLN,
TWD,
SAR,
MYR,
IDR
type
enum<string>
default:INVOICE
required

Type of invoice (e.g., Invoice, Credit Note, Reminder).

Available options:
INVOICE,
CREDIT_NOTE,
REMINDER
shouldCreateTransaction
boolean
default:true
required

Indicates whether a transaction is automatically created upon invoice approval.

alreadyPaid
boolean
default:false
required

Indicates whether the invoice has been paid.

archived
boolean
default:false
required

Indicates whether the invoice is archived.

organization
object
required

Organization associated with the invoice.

status
enum<string>
default:NEW
required

Current status of the invoice (e.g., New, Approved, Declined).

Available options:
NEW,
REJECTED,
APPROVED,
IN_PROGRESS,
CANCELLED
id
string

The unique identifier of the entity.

createdAt
string<date-time>

The date and time the entity was created.

updatedAt
string<date-time>

The date and time the entity was last updated.

originalFileName
string

Original name of the uploaded invoice file.

filename
string

Stored filename of the invoice document.

counterpartyName
string

Name of the counterparty extracted from OCR scan.

counterpartyIban
string

IBAN of the counterparty extracted from OCR scan.

counterpartyVat
string

VAT number of the counterparty extracted from OCR scan.

counterparty
object

The counterparty of the invoice.

invoiceNumber
string

Unique identifier or number of the invoice.

internalInvoiceNumber
string

Internal unique invoice number (YYYY-MM-XXXXX).

purchaseOrderNumber
string

Purchase order number associated with the invoice.

purchaseOrder
object

The matched purchase order for procurement workflow.

date
string

Issuance date of the invoice.

billingPeriodStart
string

Start date of the billing period.

billingPeriodEnd
string

End date of the billing period.

dueDate
string

Due date for invoice payment.

skontoDate
string

Deadline for skonto (early payment discount) eligibility.

skontoAmount
number

Discount amount offered for early payment within skonto terms.

skontoRate
number

Percentage rate of the skonto discount.

totalAmount
number

Total amount due for the invoice.

paymentTerms
string

Payment terms or conditions for the invoice.

notes
string

Additional comments or notes on the invoice.

alreadyPaidDate
string

Date when the invoice was paid.

archivedDate
string

Date when the invoice was archived.

archivedByUser
object

User who archived the invoice.

debitor
object

Debitor bank account associated with the invoice.

export
object

Details of the invoice export, if exported.

splits
object[]

Splits detailing the invoice breakdown, such as tax rates, or subtotals.

lineItems
object[]