List all invoices - LogicTrade API

Returns a list of your invoices. The invoices are returned sorted by id, with the most recent order appearing first.

Request

Authorization

Add parameter in header

api-key

Example:

api-key: ********************

Query Params

pageSize

integer

optional

This specifies the number of objects to returned, ranging between 10 and 100.

Example:

100

pageNumber

integer

optional

The parameter pageNumber indicates which page of the result should be requested.

Example:

number

string

optional

Search for a specific invoice based on the provided number.

reference

string

optional

Search for a specific invoice based on the provided reference.

originCode

string

optional

Search for all invoices based on the provided origin.

customerNumber

string

optional

Search for all invoices based on the provided customer number.

modifiedAfter

string <date-time>

optional

Search for all invoices that have been modified after the specified timestamp.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

pagination

object

optional

totalResults

integer

optional

The total number of records.

pageNumber

integer

optional

The current page number.

pageSize

integer

optional

The number of records returned per page.

totalPages

integer

optional

The total number of pages.

results

array [object {14}]

required

integer

read-onlyrequired

The unique identifier of the invoice.

number

string

optional

The invoice number of the invoice.

date

string <date>

The date of the order

optional

The invoice date of the invoice.

reference

string

optional

The customer reference of the invoice.

externNumber

string

read-onlyoptional

The unique external number of the invoice.

origin

object

optional

The origin of the order.

customer

object (Customer)

required

The customer for whom the invoice is made.

invoiceAddress

object

optional

The invoice address.

payments

array [object {3}]

optional

The payments for the invoice.

comment

object

optional

Comments related to the invoice.

lines

array [object {12}]

required

The invoice lines.

totalAmount

number <double>

read-onlyoptional

The total amount of the invoice (calculated field).

modifiedDate

string <date-time>

optional

The date on which the entity was last modified.

createdDate

string <date-time>

optional

The date on which the entity was created.

Example

{
  "pagination": {
    "totalResults": 3,
    "pageNumber": 1,
    "pageSize": 3,
    "totalPages": 1
  },
  "results": [
    {
      "id": 2,
      "number": "",
      "date": null,
      "reference": "",
      "externNumber": "",
      "origin": {
        "code": "WIN",
        "description": "Winkel"
      },
      "customer": {
        "id": 13,
        "number": "R000000008",
        "gender": "Man",
        "title": "Dhr.",
        "initials": "J",
        "firstName": "Jan",
        "infix": "",
        "lastName": "Jansen",
        "companyName": "",
        "phoneNumber": "",
        "mobileNumber": "06-12345678",
        "email": "jan@jansen.com",
        "remark": "",
        "address": {
          "street": "Wethouder Buitenhuisstraat",
          "houseNumber": "2B",
          "zipCode": "7951 SM",
          "city": "Staphorst",
          "country": "NL"
        }
      },
      "invoiceAddress": {
        "street": "Wethouder Buitenhuisstraat",
        "houseNumber": "2B",
        "zipCode": "7951 SM",
        "city": "Staphorst",
        "country": "NL"
      },
      "payments": [],
      "comment": {
        "intern": "",
        "extern": ""
      },
      "lines": [
        {
          "id": 1,
          "lineNumber": "10",
          "code": "LT00000043",
          "description": "Barstoelen",
          "salesGroup": {
            "code": "8010",
            "description": "Barstoelen Meubels"
          },
          "quantity": 3,
          "partPrice": 123,
          "discount": 0,
          "linePrice": 369,
          "vat": 21,
          "comment": {
            "intern": "",
            "extern": ""
          },
          "configuration": {
            "id": 0,
            "items": []
          }
        }
      ],
      "totalAmount": 369
    },
    {
      "id": 3,
      "number": "",
      "date": null,
      "reference": "",
      "externNumber": "",
      "origin": {
        "code": "",
        "description": ""
      },
      "customer": {
        "id": 14,
        "number": "R000000009",
        "gender": "Man",
        "title": "Dhr.",
        "initials": "J.",
        "firstName": "Jan",
        "infix": "",
        "lastName": "Jansen",
        "companyName": "",
        "phoneNumber": "",
        "mobileNumber": "06-12345678",
        "email": "jan@jansen.com",
        "remark": "",
        "address": {
          "street": "Wethouder Buitenhuisstraat",
          "houseNumber": "2B",
          "zipCode": "7951 SM",
          "city": "Staphorst",
          "country": "NL"
        }
      },
      "invoiceAddress": {
        "street": "Wethouder Buitenhuisstraat",
        "houseNumber": "2B",
        "zipCode": "7951 SM",
        "city": "Staphorst",
        "country": "NL"
      },
      "payments": [],
      "comment": {
        "intern": "",
        "extern": ""
      },
      "lines": [],
      "totalAmount": 0
    },
    {
      "id": 4,
      "number": "F24000001",
      "date": "2024-04-05T08:30:05.293",
      "reference": "",
      "externNumber": "",
      "origin": {
        "code": "",
        "description": ""
      },
      "customer": {
        "id": 10,
        "number": "R000000005",
        "gender": "Man",
        "title": "Dhr.",
        "initials": "J.",
        "firstName": "Jan",
        "infix": "",
        "lastName": "Jansen",
        "companyName": "",
        "phoneNumber": "",
        "mobileNumber": "06-12345678",
        "email": "jan@jansen.com",
        "remark": "Niet beschikbaar op maandag en dinsdag!",
        "address": {
          "street": "Wethouder Buitenhuisstraat",
          "houseNumber": "2B",
          "zipCode": "7951 SM",
          "city": "Staphorst",
          "country": "NL"
        }
      },
      "invoiceAddress": {
        "street": "Wethouder Buitenhuisstraat",
        "houseNumber": "2B",
        "zipCode": "7951 SM",
        "city": "Staphorst",
        "country": "NL"
      },
      "payments": [],
      "comment": {
        "intern": "",
        "extern": ""
      },
      "lines": [
        {
          "id": 3,
          "lineNumber": "10",
          "code": "LT0000000075",
          "description": "De wanden behandelen.",
          "salesGroup": {
            "code": "900",
            "description": "Arbeid wanden"
          },
          "quantity": 1,
          "partPrice": 50,
          "discount": 10,
          "linePrice": 50,
          "vat": 0,
          "comment": {
            "intern": "",
            "extern": ""
          },
          "configuration": {
            "id": 0,
            "items": []
          }
        }
      ],
      "totalAmount": 50
    }
  ]
}

🟢204No Content

🟠403Forbidden

🟠422Parameter Error