Skip to main content
GET
/
v1
/
invoice
/
{id}
Get invoice
curl --request GET \
  --url http://localhost:3001/v1/invoice/{id} \
  --header 'Authorization: Bearer <token>'
{
  "currency": "EUR",
  "type": "INVOICE",
  "shouldCreateTransaction": true,
  "alreadyPaid": false,
  "archived": false,
  "organization": {
    "name": "<string>",
    "slug": "<string>",
    "logoFileName": "<string>",
    "country": "<string>",
    "vatNumber": "<string>",
    "featureFlags": [
      {
        "featureName": "<string>",
        "isEnabled": true,
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "baseCurrency": "EUR",
    "paymentRunBatchBooking": true,
    "paymentRunVerificationOfPayee": true,
    "customExportFormats": [
      "custom_experta"
    ],
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "status": "NEW",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "originalFileName": "<string>",
  "filename": "<string>",
  "fileUrl": "<string>",
  "counterpartyName": "<string>",
  "counterpartyIban": "<string>",
  "counterpartyVat": "<string>",
  "counterparty": {
    "email": "<string>",
    "markedTrusted": true,
    "markedTrustedDate": "2023-11-07T05:31:56Z",
    "markedTrustedUser": {
      "email": "<string>",
      "name": "<string>",
      "authId": "<string>",
      "role": "<string>",
      "hasPushNotification": true,
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "description": "<string>",
    "vat": "<string>",
    "accountsPayableNumber": "22 0391919",
    "paymentTermsDays": 123,
    "skontoPercentage": 123,
    "skontoDays": 123,
    "bankAccount": {
      "name": "<string>",
      "iban": "<string>",
      "bic": "<string>",
      "countryCode": "<string>",
      "address": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "invoiceNumber": "<string>",
  "internalInvoiceNumber": "<string>",
  "purchaseOrderNumber": "<string>",
  "purchaseOrder": {
    "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,
    "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": {
      "email": "<string>",
      "name": "<string>",
      "markedTrusted": true,
      "markedTrustedDate": "2023-11-07T05:31:56Z",
      "markedTrustedUser": {
        "email": "<string>",
        "name": "<string>",
        "authId": "<string>",
        "role": "<string>",
        "hasPushNotification": true,
        "organization": {
          "name": "<string>",
          "slug": "<string>",
          "logoFileName": "<string>",
          "country": "<string>",
          "vatNumber": "<string>",
          "featureFlags": [
            {
              "featureName": "<string>",
              "isEnabled": true,
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ],
          "baseCurrency": "EUR",
          "paymentRunBatchBooking": true,
          "paymentRunVerificationOfPayee": true,
          "customExportFormats": [
            "custom_experta"
          ],
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "description": "<string>",
      "vat": "<string>",
      "accountsPayableNumber": "22 0391919",
      "street": "<string>",
      "city": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "paymentTermsDays": 123,
      "skontoPercentage": 123,
      "skontoDays": 123,
      "organization": {
        "name": "<string>",
        "slug": "<string>",
        "logoFileName": "<string>",
        "country": "<string>",
        "vatNumber": "<string>",
        "featureFlags": [
          {
            "featureName": "<string>",
            "isEnabled": true,
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "baseCurrency": "EUR",
        "paymentRunBatchBooking": true,
        "paymentRunVerificationOfPayee": true,
        "customExportFormats": [
          "custom_experta"
        ],
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "bankAccount": {
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "bankAccountVerification": {
        "bankAccount": {
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "paymentProvider": "<string>",
        "status": "VALID",
        "initializedAt": "2023-11-07T05:31:56Z",
        "mailTrackings": {
          "version": 123,
          "type": "ONBOARDING",
          "status": "ACCEPTED",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "fullName": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "transactions": [
        "<string>"
      ],
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "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
      }
    ]
  },
  "date": "<string>",
  "billingPeriodStart": "<string>",
  "billingPeriodEnd": "<string>",
  "dueDate": "<string>",
  "skontoDate": "<string>",
  "skontoAmount": 123,
  "skontoRate": 123,
  "totalAmount": 123,
  "paymentTerms": "<string>",
  "notes": "<string>",
  "alreadyPaidDate": "<string>",
  "archivedDate": "<string>",
  "archivedByUser": {
    "email": "<string>",
    "name": "<string>",
    "authId": "<string>",
    "role": "<string>",
    "hasPushNotification": true,
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "debitor": {
    "name": "<string>",
    "iban": "<string>",
    "bic": "<string>",
    "countryCode": "<string>",
    "address": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "export": {
    "invoiceCount": 123,
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "splits": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "partialAmount": 123,
      "taxRate": 123,
      "taxKey": {
        "type": "SALE",
        "name": "<string>",
        "description": "<string>",
        "internalTaxKeyName": "<string>",
        "isSystemKey": true,
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "externalCode": "<string>"
      },
      "notes": "<string>",
      "costCenter": {
        "code": "<string>",
        "name": "<string>",
        "type": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "costCenter2": {
        "code": "<string>",
        "name": "<string>",
        "type": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "ledgerAccount": {
        "accountNumber": "<string>",
        "name": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "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
      },
      "costCenter1": {
        "code": "<string>",
        "name": "<string>",
        "type": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "costCenter2": {
        "code": "<string>",
        "name": "<string>",
        "type": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "ledgerAccount": {
        "accountNumber": "<string>",
        "name": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "taxKey": {
        "type": "SALE",
        "name": "<string>",
        "description": "<string>",
        "internalTaxKeyName": "<string>",
        "isSystemKey": true,
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "externalCode": "<string>"
      }
    }
  ]
}

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.

​
fileUrl
string

Signed URL to access the invoice file from Google Cloud Storage. Valid for 7 days.

​
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[]