Create offer

POST /accounting/offers

cURL

cURL

curl --request POST \
  --url https://api.maesn.dev/accounting/offers \
  --header 'Content-Type: application/json' \
  --data '
{
  "addresses": [
    {
      "addressLine1": "Main street 45",
      "addressLine2": "2nd floor",
      "city": "Berlin",
      "countryCode": "DE",
      "postalCode": "10243",
      "type": "BILLING"
    }
  ],
  "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
  "currency": "EUR",
  "lineItems": [
    {
      "accountCode": "8400",
      "accountId": "a23cc-334rn-finsd-438m",
      "description": "SYDNEY Schreibtischstuhl, grün",
      "itemId": "f9f6653e-5be6-ee11-a201-6045bde98d28",
      "name": "GREEN CHAIR",
      "quantity": 1,
      "taxCode": "CODE.19",
      "taxRatePercentage": "19",
      "taxType": "type-19",
      "type": "ITEM",
      "totalDiscountAmount": 10,
      "totalDiscountPercentage": 10,
      "totalGrossAmount": 109,
      "totalNetAmount": 100,
      "totalTaxAmount": 19,
      "unitAmount": 100,
      "unitDiscountAmount": 10,
      "unitDiscountPercentage": 10,
      "unitName": "PIECE"
    }
  ],
  "name": "Trey Research",
  "offerDate": "2021-01-01T00:00:00Z",
  "offerNumber": "1001",
  "reference": "RCXF197253F",
  "status": "DRAFT",
  "taxText": "Tax 19 percent",
  "totalDiscountAmount": 10,
  "totalDiscountPercentage": 10,
  "totalGrossAmount": 109,
  "totalNetAmount": 100,
  "totalTaxAmount": 19
}
'

200

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 125,
      "perPage": 50,
      "currentPage": 1,
      "totalPages": 3
    }
  },
  "data": {
    "id": "9dea18d2-748e-4bda-9f4c-02b08a9622cd",
    "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",
    "currency": "EUR",
    "lineItems": [
      {
        "id": "c1f85763-5be6-ee11-a201-6045bde98d28",
        "accountCode": "8400",
        "accountId": "a23cc-334rn-finsd-438m",
        "createdDate": "2021-01-01T00:00:00Z",
        "description": "SYDNEY Schreibtischstuhl, grün",
        "itemId": "f9f6653e-5be6-ee11-a201-6045bde98d28",
        "name": "GREEN CHAIR",
        "quantity": 1,
        "taxCode": "CODE.19",
        "taxRatePercentage": "19",
        "taxType": "type-19",
        "type": "ITEM",
        "totalDiscountAmount": 10,
        "totalDiscountPercentage": 10,
        "totalGrossAmount": 109,
        "totalNetAmount": 100,
        "totalTaxAmount": 19,
        "unitAmount": 100,
        "unitDiscountAmount": 10,
        "unitDiscountPercentage": 10,
        "unitName": "STÜCK",
        "updatedDate": "2021-01-01T00:00:00Z"
      }
    ],
    "name": "Trey Research",
    "offerDate": "2021-01-01T00:00:00Z",
    "offerNumber": "1001",
    "reference": "RCXF197253F",
    "status": "DRAFT",
    "taxText": "Tax 19 percent",
    "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 response fields:

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: SELLING, DELIVERY,

contactId · string · required

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

lineItems · LineItem[]

Show properties

description · string · required

itemId · string · required

quantity · number · required

taxCode · string

type · enum · required

Available options (3-letter ISO 4217): ITEM, COMMENT, ACCOUNT, CHARGE, VALUE, RESOURCE, FIXED_ASSET

totalDiscountPercentage · number

unitAmount · number · required

unitName · string

offerDate · string

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

Headers

X-API-KEY · string

API key

X-ACCOUNT-KEY · string

Account key

Query Parameters

companyId · string

environmentName · string

Body

application/json

addresses · object[]

Show child attributes

contactId · string

Example:

"eaa28f49-6028-4b6e-bb12-d8f6278073fc"

currency · enum<string>

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"

lineItems · object[]

Show child attributes

name · string

Example:

"Trey Research"

offerDate · string

Example:

"2021-01-01T00:00:00Z"

offerNumber · string

Example:

"1001"

reference · string

Example:

"RCXF197253F"

status · enum<string>

Available options: DRAFT, SENT, ACCEPTED, VOIDED, DECLINED, EXPIRED

Example:

"DRAFT"

taxText · string

Example:

"Tax 19 percent"

totalDiscountAmount · number

Total discount applied, in the document currency.

Example:

10

totalDiscountPercentage · number

Total discount applied, as a percentage.

Example:

10

totalGrossAmount · number

Gross total — the net amount plus tax (the total payable, including VAT).

Example:

109

totalNetAmount · number

Net total — the sum of all line amounts before tax (excluding VAT).

Example:

100

totalTaxAmount · number

Tax (VAT) total — the difference between the gross and net totals.

Example:

19

Response

200 - application/json

meta · object

Show child attributes

data · object

Show child attributes