Skip to main content
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

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:
​
id
string
​
addresses
Address[]
​
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[]
​
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
Support rawData: true
Supported Response Fields:
​
id
string
​
addresses
Address[]
​
contactId
string
​
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
​
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[]
​
name
string
​
offerDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
​
offerNumber
string
​
status
string
​
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
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 Companies endpoint available under the Authentication section. Please use the id field as the companyId and the environmentId field as the environmentName.
Support rawData: true
Supported Response Fields:
​
id
string
​
addresses
Address[]
​
contactId
string
​
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
​
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[]
​
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
​
meta
object
​
data
object