Get started
Integrations
Use cases
API reference
- Accounting
- Overview
- Accounts
- Async Task
- Bills
- Bookings
- Booking Proposals
- Contacts
- Customers
- Dimensions
- Expenses
- Files
- Invoices
- Invoice Lines
- Items
- Journals
- Journal Entries
- Offers
- Offer Lines
- Payments
- Payment Terms
- Projects
- Sales Orders
- Sales Order Lines
- Suppliers
- Tax Rates
- Transactions
- Vendor Credits
- Authentication
- Tenant Management
- User
Get vendorcredits
curl --request GET \
--url https://api.maesn.dev/accounting/vendorCredits \
--header 'X-ACCOUNT-KEY: <x-account-key>' \
--header 'X-API-KEY: <x-api-key>'{
"meta": {
"warnings": [
"Field not used by target system"
],
"pagination": {
"total": 123,
"perPage": 123,
"currentPage": 123,
"totalPages": 123
}
},
"data": [
{
"id": "ABC123",
"accountId": "1",
"addresses": [
{
"addressLine1": "Street",
"addressLine2": "Building",
"city": "City",
"postalCode": "12345",
"countryCode": "DE",
"type": "BILLING"
}
],
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"createdDate": "2021-01-01T00:00:00Z",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "10",
"lineItems": [
{
"id": "1",
"accountId": "item id",
"accountNumber": "item id",
"createdDate": "2021-01-01T00:00:00Z",
"description": "Line item description",
"itemId": "10",
"itemName": "Item name",
"quantity": 1,
"taxCode": "tax code",
"taxRatePercentage": 19,
"totalDiscountAmount": 10,
"totalDiscountPercentage": 10,
"totalGrossAmount": 119,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"unitAmount": 100,
"unitDiscountAmount": 10,
"unitDiscountPercentage": 10,
"unitName": "Unit name",
"updatedDate": "2021-01-01T00:00:00Z"
}
],
"name": "Bill name",
"oneLineAddress": "Main street 45, Berlin",
"paidDate": "2021-01-01T00:00:00Z",
"paymentStatus": "PENDING",
"paymentDays": 30,
"reference": "REF-12345",
"shippingDate": "2021-01-01T00:00:00Z",
"shippingType": "SHIPPING",
"status": "DRAFT",
"taxRule": "NET",
"taxText": "Tax text",
"totalDiscountAmount": 0,
"totalDiscountPercentage": 0,
"totalGrossAmount": 109,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"updatedDate": "2021-01-01T00:00:00Z",
"vendorCreditDate": "2021-01-01T00:00:00Z",
"vendorCreditNumber": "1"
}
]
}Test Api token:
663222ee
Test Account token:
85b30b51
Field support per integration
Please ensure the query parameter companyId is accurately filled with the division code.
You can obtain this values by using the GET Companies endpoints available under the Authentication section.
Supported Response Fields:
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
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
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Available options: BAD_DEBT, PENDING, PAID
Available options: OPEN, PAID, OVERDUE
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Query Parameters
5, 10, 20, 50, 100 Response
"ABC123"
"1"
"Street"
"Building"
"City"
"12345"
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 "DE"
BILLING, DELIVERY, SELLING "BILLING"
"eaa28f49-6028-4b6e-bb12-d8f6278073fc"
"2021-01-01T00:00:00Z"
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 "EUR"
"2021-01-01T00:00:00Z"
"2021-01-01T00:00:00Z"
"10"
"1"
"item id"
"item id"
"2021-01-01T00:00:00Z"
"Line item description"
"10"
"Item name"
1
"tax code"
19
10
10
119
100
19
100
10
10
"Unit name"
"2021-01-01T00:00:00Z"
"Bill name"
"Main street 45, Berlin"
"2021-01-01T00:00:00Z"
PENDING, PAID, PARTLY_PAID, CANCELED, PARTIAL_CANCELLATION, BAD_DEBT, DEBITED "PENDING"
30
"REF-12345"
"2021-01-01T00:00:00Z"
SHIPPING, PICKUP, DELIVERY "SHIPPING"
DRAFT, CORRECTIVE, SUBMITTED, DOCUMENT_CREATED, OPEN, PARTIALLY_PAID, PAID, PARTIALLY_OVERDUE, OVERDUE, VOIDED "DRAFT"
NET, TAXFREE, INTRACOMMUNITY_GOODS, INTRACOMMUNITY_SERVICE, EXPORT_SERVICE, EXPORT_GOODS, REVERSE_CHARGE, GROSS, CONSTRUCTION_SERVICE, PHOTOVOLTAIC_EQUIPMENT, SMALL_BUSINESS_VAT_EXEMPTION, NON_DOMESTIC_SERVICE, OSS_GOODS, OSS_ELECTRONIC_SERVICES, OSS_SERVICES "NET"
"Tax text"
0
0
109
100
19
"2021-01-01T00:00:00Z"
"2021-01-01T00:00:00Z"
"1"
Was this page helpful?
curl --request GET \
--url https://api.maesn.dev/accounting/vendorCredits \
--header 'X-ACCOUNT-KEY: <x-account-key>' \
--header 'X-API-KEY: <x-api-key>'{
"meta": {
"warnings": [
"Field not used by target system"
],
"pagination": {
"total": 123,
"perPage": 123,
"currentPage": 123,
"totalPages": 123
}
},
"data": [
{
"id": "ABC123",
"accountId": "1",
"addresses": [
{
"addressLine1": "Street",
"addressLine2": "Building",
"city": "City",
"postalCode": "12345",
"countryCode": "DE",
"type": "BILLING"
}
],
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"createdDate": "2021-01-01T00:00:00Z",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "10",
"lineItems": [
{
"id": "1",
"accountId": "item id",
"accountNumber": "item id",
"createdDate": "2021-01-01T00:00:00Z",
"description": "Line item description",
"itemId": "10",
"itemName": "Item name",
"quantity": 1,
"taxCode": "tax code",
"taxRatePercentage": 19,
"totalDiscountAmount": 10,
"totalDiscountPercentage": 10,
"totalGrossAmount": 119,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"unitAmount": 100,
"unitDiscountAmount": 10,
"unitDiscountPercentage": 10,
"unitName": "Unit name",
"updatedDate": "2021-01-01T00:00:00Z"
}
],
"name": "Bill name",
"oneLineAddress": "Main street 45, Berlin",
"paidDate": "2021-01-01T00:00:00Z",
"paymentStatus": "PENDING",
"paymentDays": 30,
"reference": "REF-12345",
"shippingDate": "2021-01-01T00:00:00Z",
"shippingType": "SHIPPING",
"status": "DRAFT",
"taxRule": "NET",
"taxText": "Tax text",
"totalDiscountAmount": 0,
"totalDiscountPercentage": 0,
"totalGrossAmount": 109,
"totalNetAmount": 100,
"totalTaxAmount": 19,
"updatedDate": "2021-01-01T00:00:00Z",
"vendorCreditDate": "2021-01-01T00:00:00Z",
"vendorCreditNumber": "1"
}
]
}