Skip to main content
GET
/
v1
/
invoice
Get invoices
curl --request GET \
  --url http://localhost:3001/v1/invoice \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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": {}
          },
          "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": [
              {}
            ]
          },
          "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": {},
            "paymentProvider": "<string>",
            "status": "VALID",
            "initializedAt": "2023-11-07T05:31:56Z",
            "mailTrackings": {},
            "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": {},
            "debitor": {},
            "analysis": {},
            "archived": true,
            "archivedDate": "2023-11-07T05:31:56Z",
            "archivedByUser": {},
            "paymentRun": {}
          }
        },
        "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": [
          {}
        ]
      },
      "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
          }
        }
      ]
    }
  ],
  "meta": {
    "page": 123,
    "take": 123,
    "itemCount": 123,
    "pageCount": 123,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
searchTerm
string

The search term to look for in the invoice list.

​
status
string

Filter invoices by status.

​
counterpartyIds
string

Filter invoices by their counterparty ids.

​
excludeId
string

Exclude an invoice from the search.

​
exportId
string

Filter invoices by export ID.

​
exportable
string

Filter for exportable invoices (approved, not archived, not exported).

​
dateFrom
string

Filter invoices dates from

​
dateTo
string

Filter invoices dates to

​
dateField
enum<string>
default:invoice_date

Date field to use for date filtering (invoice date or due/payment date).

Available options:
invoice_date,
due_payment_date
​
dueFrom
string

Filter invoices due date from

​
dueTo
string

Filter invoices due date to

​
skontoFrom
string

Filter invoices skonto date from

​
skontoTo
string

Filter invoices skonto date to

​
createdFrom
string

Filter invoices created at from

​
createdTo
string

Filter invoices created at to

​
updatedFrom
string

Filter invoices updated at from

​
updatedTo
string

Filter invoices updated at to

​
costCenter1Ids
string

Filter invoices by their cost center 1 ids.

​
costCenter2Ids
string

Filter invoices by their cost center 2 ids.

​
ledgerAccountIds
string

Filter invoices by their ledger accounts ids.

​
approvalRequesterIds
string

Filter invoices by their approval requester (user).

​
currentApproverIds
string

Filter invoices by their current approvers (user).

​
invoiceTypes
string

Filter invoices by type (invoice, credit note).

​
transactionStatus
string

Filter invoices by their transaction status.

​
orderField
string

Specify the field you want to order by.

​
orderDir
string

Choose between ascending and descending order.

​
order
enum<string>
default:ASC

Choose between ascending and descending order.

Available options:
ASC,
DESC
​
page
number
default:1

Specify the number of the page you want to retrieve.

Required range: x >= 1
​
take
number
default:10

Specify the number of items you want to retrieve per page.

Required range: 1 <= x <= 100

Response

200 - application/json
​
data
object[]
required

Paginated items.

​
meta
object
required

Additional information about the page.