Create sales order

POST /accounting/salesOrders

cURL

cURL

curl --request POST \
  --url https://api.maesn.dev/accounting/salesOrders \
  --header 'Content-Type: application/json' \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "addresses": [
    {
      "addressLine1": "Main street 45",
      "addressLine2": "2nd floor",
      "city": "Berlin",
      "countryCode": "DE",
      "postalCode": "10243",
      "type": "BILLING"
    }
  ],
  "billingContactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
  "comment": "Due today",
  "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
  "currency": "EUR",
  "deliveryDate": "2021-01-01T00:00:00Z",
  "lineItems": [
    {
      "itemId": "efa82f42-fd85-11e1-a21f-0800200c9a33",
      "description": "SEOUL Guest Chair, red",
      "itemName": "RED CHAIR",
      "lineNumber": "2",
      "optional": true,
      "parentLineNumber": "1",
      "quantity": 1,
      "taxCode": "CODE.19",
      "taxRatePercentage": 19,
      "totalDiscountAmount": 10,
      "totalDiscountPercentage": 10,
      "totalGrossAmount": 109,
      "totalNetAmount": 100,
      "totalTaxAmount": 19,
      "unitAmount": 100,
      "unitDiscountAmount": 10,
      "unitDiscountPercentage": 10,
      "unitName": "PIECE"
    }
  ],
  "oneLineAddress": "Main street 45, Berlin",
  "orderDate": "2021-01-01T00:00:00Z",
  "projectId": "1",
  "shippingContactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
  "status": "OPEN",
  "totalDiscountAmount": 10,
  "totalDiscountPercentage": 10,
  "totalGrossAmount": 109,
  "totalNetAmount": 100,
  "totalTaxAmount": 19,
  "version": "1"
}
'

200

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 125,
      "perPage": 50,
      "currentPage": 1,
      "totalPages": 3
    }
  },
  "data": {
    "id": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o",
    "addresses": [
      {
        "addressLine1": "Main street 45",
        "addressLine2": "2nd floor",
        "city": "Berlin",
        "countryCode": "DE",
        "postalCode": "10243",
        "type": "BILLING"
      }
    ],
    "billingContactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
    "comment": "Due today",
    "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
    "createdDate": "2021-01-01T00:00:00Z",
    "currency": "EUR",
    "deliveryDate": "2021-01-01T00:00:00Z",
    "lineItems": [
      {
        "id": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
        "itemId": "efa82f42-fd85-11e1-a21f-0800200c9a33",
        "createdDate": "2021-01-01T00:00:00Z",
        "description": "SEOUL Guest Chair, red",
        "itemName": "RED CHAIR",
        "quantity": 1,
        "taxCode": "CODE.19",
        "taxRatePercentage": 19,
        "totalDiscountAmount": 10,
        "totalDiscountPercentage": 10,
        "totalGrossAmount": 109,
        "totalNetAmount": 100,
        "totalTaxAmount": 19,
        "unitAmount": 100,
        "unitDiscountAmount": 10,
        "unitDiscountPercentage": 10,
        "unitName": "PIECE",
        "updatedDate": "2021-01-01T00:00:00Z"
      }
    ],
    "oneLineAddress": "Main street 45, Berlin",
    "orderDate": "2021-01-01T00:00:00Z",
    "projectId": "1",
    "shippingContactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc",
    "status": "OPEN",
    "totalDiscountAmount": 10,
    "totalDiscountPercentage": 10,
    "totalGrossAmount": 109,
    "totalNetAmount": 100,
    "totalTaxAmount": 19,
    "updatedDate": "2021-01-01T00:00:00Z",
    "version": "1"
  }
}

Field support per integration

AbaConnect

This endpoint is asynchronous. If the request has not completed, the response returns a taskId. Use /asyncTask/{taskId} to check the task status and obtain the final result once it is ready.

Supported request parameters:

billingContactId · string

comment · string

contactId · string

lineItems · LineItem[]

Show properties

description · string

lineNumber · string

A unique identifier for this line item, used so other line items can reference it as their parent via parentLineNumber. Only needed when this line is part of a collective position — either as the parent or as a child. Must be a whole number between 1 and 999 (max 3 digits).

optional · boolean

parentLineNumber · string

The lineNumber of this line’s parent. Setting this turns the line into a child of a collective position — the line it points to (and this line itself) will be grouped together as a collective position instead of a standalone line item. Collective positions support one level of nesting only: a line referenced as a parentLineNumber cannot itself have a parentLineNumber.

quantity · number

totalDiscountPercentage · number

unitAmount · number

Price per unit

unitName · string

Supported values: PIECE, HOUR

projectId · string

totalDiscountPercentage · number

version · string

abacus

Please ensure the query parameter environmentName is accurately populated with the appropriate environment. You can obtain this value by using the GET Environments endpoint available under the Authentication section.

Supported request parameters:

billingContactId · string

comment · string

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

deliveryDate · string

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

lineItems · LineItem[]

Show properties

id · string

itemId · string

description · string

quantity · number

Note that quantity can be a decimal numeral.

taxRatePercentage · string

totalDiscountAmount · string

totalDiscountPercentage · string

totalGrossAmount · string

totalNetAmount · string

totalTaxAmount · string

unitAmount · string

orderDate · string

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

shippingContactId · string

status · enum

Available options: OPEN, CLOSED

totalDiscountPercentage · number

totalGrossAmount · number

Headers

X-API-KEY · string · required

API key

Example:

"example value"

X-ACCOUNT-KEY · string · required

Account key

Example:

"example value"

Query Parameters

companyId · string

environmentName · string

Body

application/json

addresses · object[]

Show child attributes

billingContactId · string

Example:

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

comment · string

Example:

"Due today"

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"

deliveryDate · string

Example:

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

lineItems · object[]

Show child attributes

oneLineAddress · string

Example:

"Main street 45, Berlin"

orderDate · string

Example:

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

projectId · string

Example:

"1"

shippingContactId · string

Example:

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

status · enum<string>

Available options: OPEN, CLOSED

Example:

"OPEN"

totalDiscountAmount · string

Total discount applied, in the document currency.

Example:

10

totalDiscountPercentage · string

Total discount applied, as a percentage.

Example:

10

totalGrossAmount · string

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

Example:

109

totalNetAmount · string

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

Example:

100

totalTaxAmount · string

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

Example:

19

version · string

Example:

"1"

Response

200 - application/json

meta · object

Show child attributes

data · object

Show child attributes