Get credit note

cURL

curl --request GET \
  --url https://api.maesn.dev/accounting/creditNotes/{creditNoteId} \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>'

import requests

url = "https://api.maesn.dev/accounting/creditNotes/{creditNoteId}"

headers = {
    "X-API-KEY": "<x-api-key>",
    "X-ACCOUNT-KEY": "<x-account-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-KEY': '<x-api-key>', 'X-ACCOUNT-KEY': '<x-account-key>'}
};

fetch('https://api.maesn.dev/accounting/creditNotes/{creditNoteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.maesn.dev/accounting/creditNotes/{creditNoteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-ACCOUNT-KEY: <x-account-key>",
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.maesn.dev/accounting/creditNotes/{creditNoteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("X-ACCOUNT-KEY", "<x-account-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.maesn.dev/accounting/creditNotes/{creditNoteId}")
  .header("X-API-KEY", "<x-api-key>")
  .header("X-ACCOUNT-KEY", "<x-account-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.maesn.dev/accounting/creditNotes/{creditNoteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["X-ACCOUNT-KEY"] = '<x-account-key>'

response = http.request(request)
puts response.read_body

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 125,
      "perPage": 50,
      "currentPage": 1,
      "totalPages": 3
    }
  },
  "data": {
    "id": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o",
    "addresses": [
      {
        "addressLine1": "Main street 45",
        "addressLine2": "2nd floor",
        "city": "Berlin",
        "countryCode": "DE",
        "postalCode": "10243",
        "type": "BILLING"
      }
    ],
    "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
    "createdDate": "2025-01-01T00:00:00Z",
    "creditNoteDate": "2025-01-01T00:00:00Z",
    "creditNoteLines": [
      {
        "id": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
        "createdDate": "2025-01-01T00:00:00Z",
        "description": "SEOUL Guest Chair, red",
        "itemId": "4271",
        "itemName": "RED CHAIR",
        "quantity": 1,
        "taxCode": "TAX19",
        "taxRatePercentage": 19,
        "totalDiscountAmount": 10,
        "totalDiscountPercentage": 10,
        "totalGrossAmount": 109,
        "totalNetAmount": 100,
        "totalTaxAmount": 19,
        "type": "SERVICE_ITEM",
        "unitAmount": 100,
        "unitDiscountAmount": 10,
        "unitDiscountPercentage": 10,
        "unitName": "PIECE",
        "updatedDate": "2025-01-01T00:00:00Z"
      }
    ],
    "creditNoteNumber": "PRES1000",
    "currency": "EUR",
    "paymentStatus": "PENDING",
    "paymentTermId": "21",
    "reference": "RCXF197253F",
    "status": "DRAFT",
    "taxRatePercentage": 19,
    "taxRule": "NET",
    "totalDiscountAmount": 10,
    "totalDiscountPercentage": 10,
    "totalGrossAmount": 109,
    "totalNetAmount": 100,
    "totalTaxAmount": 19,
    "updatedDate": "2025-01-01T00:00:00Z"
  }
}

GET

accounting

creditNotes

{creditNoteId}

cURL

curl --request GET \
  --url https://api.maesn.dev/accounting/creditNotes/{creditNoteId} \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>'

import requests

url = "https://api.maesn.dev/accounting/creditNotes/{creditNoteId}"

headers = {
    "X-API-KEY": "<x-api-key>",
    "X-ACCOUNT-KEY": "<x-account-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-KEY': '<x-api-key>', 'X-ACCOUNT-KEY': '<x-account-key>'}
};

fetch('https://api.maesn.dev/accounting/creditNotes/{creditNoteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.maesn.dev/accounting/creditNotes/{creditNoteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-ACCOUNT-KEY: <x-account-key>",
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.maesn.dev/accounting/creditNotes/{creditNoteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("X-ACCOUNT-KEY", "<x-account-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.maesn.dev/accounting/creditNotes/{creditNoteId}")
  .header("X-API-KEY", "<x-api-key>")
  .header("X-ACCOUNT-KEY", "<x-account-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.maesn.dev/accounting/creditNotes/{creditNoteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["X-ACCOUNT-KEY"] = '<x-account-key>'

response = http.request(request)
puts response.read_body

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 125,
      "perPage": 50,
      "currentPage": 1,
      "totalPages": 3
    }
  },
  "data": {
    "id": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o",
    "addresses": [
      {
        "addressLine1": "Main street 45",
        "addressLine2": "2nd floor",
        "city": "Berlin",
        "countryCode": "DE",
        "postalCode": "10243",
        "type": "BILLING"
      }
    ],
    "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
    "createdDate": "2025-01-01T00:00:00Z",
    "creditNoteDate": "2025-01-01T00:00:00Z",
    "creditNoteLines": [
      {
        "id": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
        "createdDate": "2025-01-01T00:00:00Z",
        "description": "SEOUL Guest Chair, red",
        "itemId": "4271",
        "itemName": "RED CHAIR",
        "quantity": 1,
        "taxCode": "TAX19",
        "taxRatePercentage": 19,
        "totalDiscountAmount": 10,
        "totalDiscountPercentage": 10,
        "totalGrossAmount": 109,
        "totalNetAmount": 100,
        "totalTaxAmount": 19,
        "type": "SERVICE_ITEM",
        "unitAmount": 100,
        "unitDiscountAmount": 10,
        "unitDiscountPercentage": 10,
        "unitName": "PIECE",
        "updatedDate": "2025-01-01T00:00:00Z"
      }
    ],
    "creditNoteNumber": "PRES1000",
    "currency": "EUR",
    "paymentStatus": "PENDING",
    "paymentTermId": "21",
    "reference": "RCXF197253F",
    "status": "DRAFT",
    "taxRatePercentage": 19,
    "taxRule": "NET",
    "totalDiscountAmount": 10,
    "totalDiscountPercentage": 10,
    "totalGrossAmount": 109,
    "totalNetAmount": 100,
    "totalTaxAmount": 19,
    "updatedDate": "2025-01-01T00:00:00Z"
  }
}

Field support per integration

BuchhaltungsButler

Query parameters:

boolean

Supported response fields:

string

For date format details visit the Standardized Data section

string

enum

The currency field supports ISO 4217 (3-letter codes). For details visit the Standardized Data section.

enum

Available options: PENDING, PARTLY_PAID, PAID

enum

Available options: OPEN, PAID

number

Derived from the gross amount and the VAT rate returned by BuchhaltungsButler.

number

Derived from the gross amount and the VAT rate returned by BuchhaltungsButler.

Lexware Office

Query parameters:

boolean

Supported response fields:

string

Address[]

Show properties

string

enum

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

LineItem[]

Show properties

string

number

enum

Available options: SERVICE_ITEM, MATERIAL, CUSTOM, TEXT

number

string

enum

Available options: DRAFT, OPEN, PAID, VOIDED

enum

Available options: NET, TAXFREE, INTRACOMMUNITY_GOODS, INTRACOMMUNITY_SERVICE, EXPORT_SERVICE, EXPORT_GOODS, GROSS, CONSTRUCTION_SERVICE

number

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

Business Central

If you’re not using the Interactive Authentication Flow, make sure the query parameters environmentName and companyId are correctly populated. You can obtain these values by using the GET Environments and GET Companies endpoints available under the Authentication section.

Query parameters:

boolean

Supported response fields:

string

Address[]

Show properties

string

enum

Available options (ISO 3166-1 alpha-2): AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

enum

Available options: BILLING, DELIVERY, SELLING

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

LineItem[]

Show properties

string

number

Note that quantity can be a decimal numeral.

string

number

string

enum

Available options (3-letter ISO 4217):
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR

string

enum

Available options: DRAFT, OPEN, SUBMITTED, VOIDED, CORRECTIVE, PAID

number

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

weclapp

Query parameters:

boolean

Supported response fields:

string

Address[]

Show properties

string

enum

Available options: BILLING, DELIVERY

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

LineItem[]

Show properties

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

string

number

string

number

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

string

enum

Available options (3-letter ISO 4217): AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR

enum

Available options: NO_OPEN_ITEM, PENDING, PAID, CREDIT_NOTE_CLEARED, UNKNOWN,

enum

Available options: DRAFT, DOCUMENT_CREATED,OPEN, VOIDED

number

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

sevDesk

Query parameters:

boolean

Supported response fields:

string

Address[]

Show properties

string

enum

Available options: BILLING

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

LineItem[]

Show properties

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

string

number

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

string

enum

The currency field supports ISO 4217 (3-letter codes). For details visits the Standardized Data section.

string

enum

Available options: DRAFT, OPEN, PARTIALLY_PAID, PAID

enum

Available options: NET, TAXFREE, INTRACOMMUNITY_SERVICE, EXPORT_SERVICE, REVERSE_CHARGE, SMALL_BUSINESS_EXEMPTION, NON_DOMESTIC_SERVICE, OSS_GOODS, OSS_ELECTRONIC_SERVICES, OSS_SERVICES

number

string

ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

Headers

X-API-KEY

string

required

API key

X-ACCOUNT-KEY

string

required

Account key

Path Parameters

creditNoteId

string

required

Query Parameters

companyId

string

environmentName

string

rawData

boolean

Response

200 - application/json

Get started

Guides

Integrations

Use cases

API reference

Knowledgebase

Get credit note

Field support per integration

Headers

Path Parameters

Query Parameters

Response

​Field support per integration

Headers

Path Parameters

Query Parameters

Response

Field support per integration