Skip to main content
GET
/
v1
/
accounts-receivable
Get accounts receivable invoices
curl --request GET \
  --url http://localhost:3001/v1/accounts-receivable \
  --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>",
      "purchaseOrder": "<string>",
      "date": "<string>",
      "billingPeriodStart": "<string>",
      "billingPeriodEnd": "<string>",
      "dueDate": "<string>",
      "totalAmount": 123,
      "taxRate": 123,
      "skontoDate": "<string>",
      "skontoAmount": 123,
      "skontoRate": 123,
      "currency": "EUR",
      "type": "INVOICE",
      "category": "GOODS",
      "paymentTerms": "<string>",
      "notes": "<string>",
      "alreadyPaid": true,
      "alreadyPaidDate": "<string>",
      "archived": true,
      "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": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "featureName": "<string>",
            "isEnabled": true
          }
        ]
      },
      "status": "OUTSTANDING",
      "paymentMethodType": "BANK_TRANSFER",
      "transactionMatches": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "bankTransaction": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "transactionId": "<string>",
            "amount": 123,
            "currency": "EUR",
            "bookingDate": "2023-11-07T05:31:56Z",
            "remittanceInformation": "<string>",
            "additionalInformation": "<string>",
            "counterPartyName": "<string>",
            "counterPartyIban": "<string>",
            "transactionType": "incoming",
            "endToEndId": "<string>",
            "matchedInvoicesSum": 123,
            "matchingStatus": "NOT_MATCHED"
          },
          "matchedAmount": 123,
          "matchType": "MANUAL",
          "matchConfidence": "HIGH",
          "matchedBy": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "email": "<string>",
            "name": "<string>",
            "authId": "<string>",
            "role": "<string>",
            "hasPushNotification": true
          },
          "notes": "<string>",
          "metadata": {},
          "matchedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "manuallyMarkedPaid": true,
      "manuallyMarkedPaidAt": "<string>",
      "manuallyMarkedPaidBy": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "name": "<string>",
        "authId": "<string>",
        "role": "<string>",
        "hasPushNotification": true
      },
      "matchedTransactionsSum": 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.

​
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

​
paidDateFrom
string

Filter invoices paid date from (when they were paid)

​
paidDateTo
string

Filter invoices paid date to (when they were paid)

​
skontoFrom
string

Filter invoices skonto date from

​
skontoTo
string

Filter invoices skonto date to

​
invoiceTypes
string

Filter invoices by type (invoice, credit note).

​
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.