List invoices | Payrexx Octri Demo

3 status codes

200Returns a response containing an array of invoice objects, list metadata, and a status value.

dataarray<object>optional

metaobjectoptional

statusstringoptional

400Returned when the request is invalid.

errorobjectoptional

messagestringoptional

reasonstringoptional

statusstringoptional

404Returned when the requested Bill resource cannot be found.

errorobjectoptional

messagestringoptional

reasonstringoptional

statusstringoptional

Error handling

A 400 is returned when the request is invalid. A 404 is returned when the requested Bill resource cannot be found.

import { Client } from "payrexx-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://api.payrexx.com/v1.16",
});

const result = await client.bill.list();

"{\n  \"status\": \"success\",\n  \"data\": [\n    {\n      \"status\": \"draft\",\n      \"payment_status\": \"unpaid\",\n      \"id\": \"md021nl8\",\n      \"date\": \"2019-04-01\",\n      \"number\": 1,\n      \"total\": 2700,\n      \"language\": \"de\",\n      \"currency\": \"CHF\",\n      \"due_after_days\": 0,\n      \"recipient\": {\n        \"company\": \"My company\",\n        \"first_name\": \"John\",\n        \"last_name\": \"Doe\",\n        \"address\": \"Main Street 100\",\n        \"zip\": \"1000\",\n        \"city\": \"Wien\",\n        \"country\": \"AT\",\n        \"email\": \"john.doe@example.com\"\n      },\n      \"service_period\": {\n        \"from\": \"2019-03-01\",\n        \"to\": \"2019-03-10\"\n      },\n      \"discount\": {\n        \"amount\": 0,\n        \"type\": \"percent\"\n      },\n      \"cash_discounts\": [\n        {\n          \"days\": 10,\n          \"percent\": 2\n        }\n      ],\n      \"shipping_cost\": 700,\n      \"application_fee\": 1000,\n      \"note\": \"\",\n      \"terms\": \"\",\n      \"transactions\": [],\n      \"positions\": [\n        {\n          \"id\": \"91m3n01a\",\n          \"title\": \"\",\n          \"description\": \"\",\n          \"type\": \"piece\",\n          \"number\": 2,\n          \"price\": 1000,\n          \"discount\": {\n            \"amount\": 0,\n            \"type\": \"percent\"\n          },\n          \"vat\": 0\n        }\n      ],\n      \"payment_link\": \"\",\n      \"attachments\": [],\n      \"bank_information\": {\n        \"iban\": \"\",\n        \"name\": \"\",\n        \"address\": \"\"\n      },\n      \"payout_descriptor\": \"\",\n      \"psp\": [],\n      \"pm\": [],\n      \"mails\": [],\n      \"reference\": \"myref_0001\",\n      \"design\": \"85af2122\",\n      \"reminders\": [\n        {\n          \"id\": \"25dec6ed\",\n          \"days\": 20,\n          \"friendly\": true,\n          \"fee\": 0,\n          \"delay_type\": \"days_after_invoice_date\",\n          \"status\": \"sent\",\n          \"reminder_date\": \"2021-03-17T00:00:00+00:00\"\n        },\n        {\n          \"id\": \"e37eb554\",\n          \"days\": 5,\n          \"friendly\": true,\n          \"fee\": 0,\n          \"delay_type\": \"days_before_due_date\",\n          \"status\": \"active\",\n          \"reminder_date\": \"2021-03-22T00:00:00+00:00\"\n        },\n        {\n          \"id\": \"c17ae3db\",\n          \"days\": 20,\n          \"friendly\": false,\n          \"fee\": 1000,\n          \"delay_type\": \"days_after_due_date\",\n          \"status\": \"active\",\n          \"reminder_date\": \"2021-04-16T00:00:00+00:00\"\n        }\n      ],\n      \"purchaseOnInvoiceInformation\": {\n        \"company\": \"Payrexx AG\",\n        \"address\": \"Burgstrasse 18\",\n        \"zip\": \"3600\",\n        \"place\": \"Thun\",\n        \"bankName\": \"Klarpay AG\",\n        \"swift\": \"KLARCH22XXX\",\n        \"iban\": \"CH083000522710975202X\",\n        \"reference\": \"287133000000000000000001950\"\n      }\n    }\n  ],\n  \"meta\": {\n    \"object\": \"merchant_invoice\",\n    \"parent\": {\n      \"object\": \"merchant\",\n      \"id\": \"cedad42m\"\n    },\n    \"is_list\": false,\n    \"isList\": true,\n    \"hasMore\": true,\n    \"lastElement\": \"37f386cb\"\n  }\n}"

Response

Errors