Get started
Integrations
Use cases
API reference
- Accounting
- Overview
- Accounts
- Async Task
- Bills
- Booking Proposals
- Contacts
- Customers
- Dimensions
- Expenses
- Files
- Invoices
- Invoice Lines
- Items
- Journals
- Offers
- Offer Lines
- Payments
- Payment Terms
- Projects
- Sales Orders
- Sales Order Lines
- Suppliers
- Tracking categories
- Tax Rates
- Transactions
- Vendor Credits
- Authentication
- Tenant Management
- User
Vendor Credits
Create vendorcredit
POST
/
accounting
/
vendorCredits
curl --request POST \
--url https://api.maesn.dev/accounting/vendorCredits \
--header 'Content-Type: application/json' \
--data '{
"accountId": "1",
"addresses": [
{
"addressLine1": "Street",
"addressLine2": "Building",
"city": "City",
"postalCode": "12345",
"countryCode": "DE",
"type": "BILLING"
}
],
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "10",
"lineItems": [
{
"accountId": "item id",
"accountNumber": "item id",
"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"
}
],
"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,
"vendorCreditDate": "2021-01-01T00:00:00Z",
"vendorCreditNumber": "1"
}'{
"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
Supported Request Parameters:
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
Body
application/json
Example:
"1"
Example:
"Street"
Example:
"Building"
Example:
"City"
Example:
"12345"
Available options:
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 Example:
"DE"
Available options:
BILLING, DELIVERY, SELLING Example:
"BILLING"
Example:
"eaa28f49-6028-4b6e-bb12-d8f6278073fc"
Available options:
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 Example:
"EUR"
Example:
"2021-01-01T00:00:00Z"
Example:
"2021-01-01T00:00:00Z"
Example:
"10"
Example:
"item id"
Example:
"item id"
Example:
"Line item description"
Example:
"10"
Example:
"Item name"
Example:
1
Example:
"tax code"
Example:
19
Example:
10
Example:
10
Example:
119
Example:
100
Example:
19
Example:
100
Example:
10
Example:
10
Example:
"Unit name"
Example:
"Bill name"
Example:
"Main street 45, Berlin"
Example:
"2021-01-01T00:00:00Z"
Available options:
PENDING, PAID, PARTLY_PAID, CANCELED, PARTIAL_CANCELLATION, BAD_DEBT, DEBITED Example:
"PENDING"
Example:
30
Example:
"REF-12345"
Example:
"2021-01-01T00:00:00Z"
Available options:
SHIPPING, PICKUP, DELIVERY Example:
"SHIPPING"
Available options:
DRAFT, CORRECTIVE, SUBMITTED, DOCUMENT_CREATED, OPEN, PARTIALLY_PAID, PAID, PARTIALLY_OVERDUE, OVERDUE, VOIDED Example:
"DRAFT"
Available options:
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 Example:
"NET"
Example:
"Tax text"
Example:
0
Example:
0
Example:
109
Example:
100
Example:
19
Example:
"2021-01-01T00:00:00Z"
Example:
"1"
Response
200 - application/json
Example:
"ABC123"
Example:
"1"
Example:
"Street"
Example:
"Building"
Example:
"City"
Example:
"12345"
Available options:
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 Example:
"DE"
Available options:
BILLING, DELIVERY, SELLING Example:
"BILLING"
Example:
"eaa28f49-6028-4b6e-bb12-d8f6278073fc"
Example:
"2021-01-01T00:00:00Z"
Available options:
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 Example:
"EUR"
Example:
"2021-01-01T00:00:00Z"
Example:
"2021-01-01T00:00:00Z"
Example:
"10"
Example:
"1"
Example:
"item id"
Example:
"item id"
Example:
"2021-01-01T00:00:00Z"
Example:
"Line item description"
Example:
"10"
Example:
"Item name"
Example:
1
Example:
"tax code"
Example:
19
Example:
10
Example:
10
Example:
119
Example:
100
Example:
19
Example:
100
Example:
10
Example:
10
Example:
"Unit name"
Example:
"2021-01-01T00:00:00Z"
Example:
"Bill name"
Example:
"Main street 45, Berlin"
Example:
"2021-01-01T00:00:00Z"
Available options:
PENDING, PAID, PARTLY_PAID, CANCELED, PARTIAL_CANCELLATION, BAD_DEBT, DEBITED Example:
"PENDING"
Example:
30
Example:
"REF-12345"
Example:
"2021-01-01T00:00:00Z"
Available options:
SHIPPING, PICKUP, DELIVERY Example:
"SHIPPING"
Available options:
DRAFT, CORRECTIVE, SUBMITTED, DOCUMENT_CREATED, OPEN, PARTIALLY_PAID, PAID, PARTIALLY_OVERDUE, OVERDUE, VOIDED Example:
"DRAFT"
Available options:
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 Example:
"NET"
Example:
"Tax text"
Example:
0
Example:
0
Example:
109
Example:
100
Example:
19
Example:
"2021-01-01T00:00:00Z"
Example:
"2021-01-01T00:00:00Z"
Example:
"1"
Was this page helpful?
curl --request POST \
--url https://api.maesn.dev/accounting/vendorCredits \
--header 'Content-Type: application/json' \
--data '{
"accountId": "1",
"addresses": [
{
"addressLine1": "Street",
"addressLine2": "Building",
"city": "City",
"postalCode": "12345",
"countryCode": "DE",
"type": "BILLING"
}
],
"contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
"currency": "EUR",
"deliveryDate": "2021-01-01T00:00:00Z",
"dueDate": "2021-01-01T00:00:00Z",
"journalCode": "10",
"lineItems": [
{
"accountId": "item id",
"accountNumber": "item id",
"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"
}
],
"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,
"vendorCreditDate": "2021-01-01T00:00:00Z",
"vendorCreditNumber": "1"
}'{
"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"
}
}