Get credit notes

cURL

curl --request GET \
  --url https://api.maesn.dev/accounting/creditNotes \
  --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"
    }
  ]
}

GET

accounting

creditNotes

cURL

curl --request GET \
  --url https://api.maesn.dev/accounting/creditNotes \
  --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

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.

Supported filters: lastModifiedAt
Supported Response Fields:

string

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

city

string

postalCode

string

countryCode

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

type

enum

Available options: BILLING, DELIVERY, SELLING

contactId

string

creditNoteDate

string

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

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

paymentTermId

string

status

enum

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

totalDiscountAmount

number

totalGrossAmount

string

totalNetAmount

string

totalTaxAmount

string

updatedDate

string

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

weclapp

Supported filters:

lastModifiedAt

Support pagination: trueSupport rawData: true
Supported Response Fields:

string

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

city

string

postalCode

string

countryCode

enum

type

enum

Available options: BILLING, DELIVERY

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[]

Show properties

string

createdDate

string

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

itemId

string

itemName

string

quantity

number

taxCode

string

totalDiscountPercentage

number

totalGrossAmount

number

totalNetAmount

number

unitAmount

number

unitName

string

updatedDate

string

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

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

Query Parameters

page

number

limit

enum<number>

Available options:

5,

10,

20,

50,

100

companyId

string

environmentName

string

lastModifiedAt

string

rawData

boolean

Response

200 - application/json

​Field support per integration

Headers

Query Parameters

Response

Field support per integration