Get offer - maesn

cURL

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

GET

accounting

offers

{offerId}

cURL

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

Support rawData: true
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

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

string

accountId

string

description

string

itemId

string

quantity

number

taxCode

string

taxRatePercentage

number

type

enum

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

totalDiscountAmount

number

totalDiscountPercentage

number

totalGrossAmount

number

totalNetAmount

number

totalTaxAmount

number

unitAmount

number

unitName

string

name

string

offerDate

string

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

offerNumber

string

status

enum

Available options: DRAFT, EXPIRED, SENT, ACCEPTED

totalDiscountAmount

number

totalGrossAmount

number

totalNetAmount

number

totalTaxAmount

number

updatedDate

string

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

Lexware Office

Support rawData: true
Supported Response Fields:

string

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

city

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, FKP, 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

postalCode

string

type

enum

Available options: BILLING, DELIVERY

contactId

string

createdDate

string

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

currency

enum

lineItems

LineItem[]

Show properties

name

string

quantity

number

Note that quantity can be a decimal numeral.

taxRatePercentage

number

totalGrossAmount

number

totalNetAmount

number

totalDiscountPercentage

number

unitAmount

number

name

string

offerDate

string

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

offerNumber

string

status

enum

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

type

enum

Available options: ACCOUNT, RESOURCE, VALUE, COMMENT

totalGrossAmount

number

totalNetAmount

number

totalTaxAmount

number

updatedDate

string

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

Sage Active

If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section. Please use the id field as the companyId.

Support rawData: true
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, FKP, 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

contactId

string

createdDate

string

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

currency

enum

lineItems

LineItem[]

Show properties

string

createdDate

string

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

itemId

string

name

string

quantity

number

Note that quantity can be a decimal numeral.

taxRatePercentage

number

totalGrossAmount

number

totalNetAmount

number

unitAmount

number

unitDiscountPercentage

number

updatedDate

string

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

name

string

offerDate

string

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

offerNumber

string

status

enum

Available options: DRAFT, VOIDED, DECLINED

totalDiscountAmount

number

totalGrossAmount

number

totalNetAmount

number

totalTaxAmount

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

offerId

string

required

Query Parameters

companyId

string

environmentName

string

rawData

boolean

Response

200 - application/json

​Field support per integration

Headers

Path Parameters

Query Parameters

Response

Field support per integration