Skip to main content
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>'
{
  "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": "2021-01-01T00:00:00Z",
    "creditNoteDate": "2021-01-01T00:00:00Z",
    "creditNoteLines": [
      {
        "id": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
        "createdDate": "2021-01-01T00:00:00Z",
        "description": "SEOUL Guest Chair, red",
        "itemId": "4271",
        "itemName": "RED CHAIR",
        "quantity": "1",
        "taxRatePercentage": 19,
        "totalDiscountAmount": 10,
        "totalDiscountPercentage": 10,
        "totalGrossAmount": 109,
        "totalNetAmount": 100,
        "totalTaxAmount": 19,
        "unitAmount": 100,
        "unitDiscountAmount": 10,
        "unitDiscountPercentage": 10,
        "unitName": "PIECE",
        "updatedDate": "2021-01-01T00:00:00Z"
      }
    ],
    "creditNoteNumber": "PRES1000",
    "currency": "EUR",
    "paymentStatus": "PENDING",
    "paymentTermId": "21",
    "reference": "RCXF197253F",
    "status": "DRAFT",
    "totalDiscountAmount": 10,
    "totalDiscountPercentage": 10,
    "totalGrossAmount": 109,
    "totalNetAmount": 100,
    "totalTaxAmount": 19,
    "updatedDate": "2021-01-01T00:00:00Z"
  }
}

Field support per integration

Support rawData: true
Supported Response Fields:
id
string
addresses
Address[]
contactId
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteLines
LineItem[]
creditNoteNumber
string
currency
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
paymentStatus
enum
Available options: NO_OPEN_ITEM, PENDING, PAID, CREDIT_NOTE_CLEARED, UNKNOWN,
status
enum
Available options: DRAFT, DOCUMENT_CREATED,OPEN, VOIDED
totalGrossAmount
number
totalNetAmount
number
updatedDate
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
meta
object
data
object