API Documentation
API Endpoints/Creditnotes

List creditnotes with pagination

GET
/creditnotes
AuthorizationBasic <token>

Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.Example: Authorization: Basic ZGVtbzpwQDU1dzByZA==

In: header

Query Parameters

page?integer
Default1
pageSize?integer
Default1
sort?string
query?object

Filters for LIST calls. Supports multiple filtering operators.

Empty Object

Response Body

curl -X GET "https://staging1.abillify.dev/api/creditnotes?page=3&pageSize=20&sort=created&query=%5Bobject+Object%5D"
fetch("https://staging1.abillify.dev/api/creditnotes?page=3&pageSize=20&sort=created&query=%5Bobject+Object%5D")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://staging1.abillify.dev/api/creditnotes?page=3&pageSize=20&sort=created&query=%5Bobject+Object%5D"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://staging1.abillify.dev/api/creditnotes?page=3&pageSize=20&sort=created&query=%5Bobject+Object%5D"

response = requests.request("GET", url)

print(response.text)
{
  "page": 3,
  "pageSize": 20,
  "query": {
    "created": "2023-01-01 00:00:00",
    "created[$gt]": "2023-01-01",
    "created[$gte]": "2023-01-01",
    "created[$in]": [
      "2023-01-01 00:00:00",
      "2023-01-01 00:00:01"
    ],
    "created[$lt]": "2023-01-01",
    "created[$lte]": "2023-01-01",
    "created[$ne]": "2023-01-03 00:00:00"
  },
  "rows": [
    {
      "accountingdate": "2020-01-01T00:00:00.000Z",
      "addresses": [
        {
          "city": "Berlin",
          "country": "DE",
          "extra": "C/O Mr. Smith",
          "housenumber": "1",
          "info": "string",
          "kind": "shipping",
          "state": "Berlin",
          "street": "Main Street",
          "zipcode": "10115",
          "company": "ACME Inc.",
          "firstname": "John",
          "lastname": "Doe"
        }
      ],
      "cancelationdate": "2020-01-01T00:00:00.000Z",
      "created": "2020-01-01T00:00:00.000Z",
      "currency": "EUR",
      "detail": {
        "footerText": [
          "Line 1",
          "Line 2, possibly in a different language"
        ],
        "footerTextId": "5ad2114c-9bf0-4dd2-a058-a4047dbabdeb",
        "introText": [
          "Line 1",
          "Line 2, possibly in a different language"
        ],
        "introTextId": "6ad2114c-9bf0-4dd2-a058-a4047dbabdeb",
        "paymentterm": "Der Betrag wird automatisch auf Ihr Konto überwiesen.",
        "paymenttermId": "4ad2114c-9bf0-4dd2-a058-a4047dbabdeb",
        "reverseCharge": true,
        "vatId": "DE987654321"
      },
      "dunninglevel": 0,
      "dunningstate": "open",
      "id": "5e4a7b2b-1b0b-4c7a-8f0a-5b9b6b7c8d9e",
      "identity": {
        "debtor": "10001",
        "reference": "1234567890"
      },
      "issued": "2020-01-01T00:00:00.000Z",
      "items": [
        {
          "account": "8400",
          "costcenter": "8086",
          "created": "2020-01-01T00:00:00.000Z",
          "detail": {
            "taxprofile": "default",
            "vatclause": "Umsatzsteuerbefreit gem. UstG. §4 Nr. 1a"
          },
          "id": "5e4a7b2b-1b0b-4c7a-8f0a-5b9b6b7c8d9e",
          "kind": "principal",
          "label": "Couch Grey 3-Seater",
          "modified": "2020-01-01T00:00:00.000Z",
          "net": -991.6,
          "number": "1234567890",
          "pos": 1,
          "product_number": "1234567890",
          "quantity": 1,
          "reference": "1234567890",
          "servicebegin": "2020-01-01T00:00:00.000Z",
          "serviceend": "2020-01-01T00:00:00.000Z",
          "taxaccount": "1776",
          "taxrate": 0.19,
          "unit": "pieces",
          "unitprice": -1190
        }
      ],
      "meta": {
        "custom_key": "custom_value"
      },
      "modified": "2020-01-01T00:00:00.000Z",
      "net": -991.6,
      "netbased": true,
      "number": "1234567890",
      "orderdate": "2020-01-01T00:00:00.000Z",
      "ordernumber": "1234567890",
      "paymentkind": "CT",
      "reference": "1234567890",
      "tax": -188.4,
      "total": -1180
    }
  ],
  "sort": "created"
}
{
  "code": 400,
  "details": [
    {
      "error": "Value for field 'debtor' is of wrong type, expected bigint.",
      "fields": [
        "debtor"
      ],
      "hint": "Value must be a number or a string containing only a number."
    }
  ],
  "message": "InvalidValue, see error details",
  "name": "ClientError",
  "type": "ERR_INVALID_VALUE"
}
{
  "code": 400,
  "details": [
    {
      "error": "Value for field 'debtor' is of wrong type, expected bigint.",
      "fields": [
        "debtor"
      ],
      "hint": "Value must be a number or a string containing only a number."
    }
  ],
  "message": "InvalidValue, see error details",
  "name": "ClientError",
  "type": "ERR_INVALID_VALUE"
}