Create Order

The creation of a order is the first step in the accounting process of Accounting as a Service.

More information can be found in our Link

Path

POST /businesses/{businessCode}/customers/{customerNumber}/orders

Request Parameters

businessCode

required

string

The business in the context of which this request is to be executed, e.g. 1000

customerNumber

required

string

The customer in the context of which this request is to be executed, e.g. TFI2021072801

X-Request-ID

string

The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.

Request Body

application/json

object

additionalAddressLine

string

Max length: 40

maxLength(40)
Name of the intermediary responsible for transferring a mail item between the postal system and the final recipient, e.g. 'Jane c/o John'. This field is also to be used for company, authority and organisation names, e.g. 'Sportverein Blau-Weiss e.V.'

countryCode

required

string

Format([A-Z]{2})
Country code (encoded as 2-letter code according to ISO 3166-1 alpha-2)

postalCode

required

string

Max length: 10

maxLength(10)
Postal code

postalPlace

required

string

Max length: 40

maxLength(40)
Postal place, e.g. city

street

required

string

Max length: 60

maxLength(60)
Name of street or packstation

streetNumber

string

Max length: 10

maxLength(10)
Street or packstation number

firstName

string

Max length: 40

maxLength(40)
First name

language

required

string

Format([a-z]{2})
Language to be used for communication (encoded as 2-letter code according to ISO 639-1 alpha-2)

lastName

string

Max length: 40

maxLength(40)
Last name

salutation

string

Enum:

MRS

COMPANY

UNDEFINED

Salutation of the (natural or legal) person: * MR = Mr * MRS = Mrs * COMPANY = Company * UNDEFINED = undefined

title

string

Enum:

PROF

PROF_DR

BACHELOR_OF_ARTS

MBA

DOCTOR_OF_PHILOSOPHY

Title of the person who can be contacted at this address: * DR = Dr. Doctor * PROF = Prof. Professor * PROF_DR = Prof. Dr. Professor Doctor * BACHELOR_OF_ARTS = B.A. Bachelor of Arts * MBA = MBA Master of Business Administration * DOCTOR_OF_PHILOSOPHY = Ph.D. Doctor of Philosophy

birthDate

string

yyyy-MM-dd

Format(yyyy-MM-dd)
Date of birth. Not applicable to companies and other legal persons.

customerGroup

string

Max length: 25

maxLength(25)
The group that this customer belongs to

string

Max length: 241

maxLength(241).Format(email)
E-Mail address

nationality

string

Format([A-Z]{2})
Nationality of this customer (encoded as 2-letter code according to ISO 3166-1 alpha-2)

phone

string

Max length: 20

maxLength(20).Format(phone)
Phone number

taxIdentificationNumber

string

Max length: 20

maxLength(20)
Tax identification number (VAT ID)

carrier

string

Max length: 32

maxLength(32)
Name of the Carrier. Required for chargeback handling

object

contract

N/A

currency

required

string

Format([A-Z]{3})
Currency used in order (encoded as 3-letter code according to ISO 4217)

array

description

string

Max length: 40

maxLength(40)
Name or title of product

grossUnitPrice

number

Gross unit price (incl. VAT) of item

netAmount

number

Net Amount of item

netAmountEUR

number

Net unit price (incl. VAT) of item (in EUR)

quantity

number

Values(>0)
Quantity

vatAmount

number

Tax value of country tax

vatPercent

number

Values(0-100)
Tax rate of country tax in %

additionalInvoiceInformation

string

Max length: 255

maxLength(255)
Additional information for the invoice

grossTotalPrice

number

Gross total price (incl. VAT) of item position

netTotalPriceInfo

number

Net total price (excl. VAT) of item position. For information only!

netUnitPriceInfo

number

Net unit price (excl. VAT) of item position. For information only!

orderItemReference

required

integer

Values(1-999999)
External reference of the line item in the order

positionType

string

Enum:

IBAN_VERIFICATION

LOYALTY_CARD

SHIPPING_COSTS_EXPRESS

FREE_ARTICLE

GIFT_CARD_VOUCHER_PAYMENT

GIFT_CARD_VOUCHER_SALE

SERVICE_CHARGE

CASH_ON_DELIVERY

MARKETPLACE_PROVISION

SUBSCRIPTION_ORDER

SUBSCRIPTION_ORDER_2

SALES_ARTICLE

DISCOUNT

SHIPPING_COSTS

DISCOUNT_FOR_SUBSCRIPTION_ORDER

NOT_ACCOUNTING_RELEVANT

CREDIT_NOTE

Type of product: * IBAN_VERIFICATION = IBAN verification * LOYALTY_CARD = Loyalty Card * SHIPPING_COSTS_EXPRESS = Shipping costs (express) * FREE_ARTICLE = Free article * GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment * GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale * SERVICE_CHARGE = Service Charge * CASH_ON_DELIVERY = Cash on delivery * MARKETPLACE_PROVISION = Marketplace-Provision * SUBSCRIPTION_ORDER = Subscription Order * SALES_ARTICLE = Sales Article * DISCOUNT = Discount * SHIPPING_COSTS = Shipping costs * DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order * NOT_ACCOUNTING_RELEVANT = Not accounting relevant

productId

string

Max length: 30

maxLength(30)
Article number of line item

object

unitType

string

Enum:

KWH

MIN

FLT

Type of unit (quantityType): * ST = piece * KWH = KiloWattHour * MIN = Minute * FLT = Flat

vatType

required

string

Enum:

TAXLESS

NORMAL

REDUCED

REVERSE

Type of VAT * TAXLESS = taxless * NORMAL = normal * REDUCED = reduced * REVERSE = reversed

orderChannel

required

string

Enum:

ECOM

MOTO

MOBILE

POS

APP

P2P

Sales channel used: * ECOM = eCom (default) * MOTO = MoTo (MailOrder TelephoneOrder) * MOBILE = Mobile * POS = POS * APP = Application * P2P = P2P

orderDate

required

string

yyyy-MM-dd

Format(yyyy-MM-dd)
Date the order has been placed

orderReference

required

string

Max length: 16

maxLength(16)
Specific order reference from merchant (alphanumeric characters, only)

orderType

required

string

Enum:

PHYSICAL_GOODS

DIGITAL_GOODS

BANK_VERIFICATION

Defines the type of order resp. delivery being made: * PHYSICAL_GOODS = physical goods * DIGITAL_GOODS = digital goods * BANK_VERIFICATION = bank verification

object

processAfterDunning

string

Enum:

HAND_OVER_FOR_DEBT_COLLECTION

HAND_OVER_FOR_FACTORING

Decision if overdue orders should be sold or handed over for debt collection: * HAND_OVER_FOR_DEBT_COLLECTION = hand over for debt collection * HAND_OVER_FOR_FACTORING = hand over for factoring

object

Additional information that may be used later for reporting purposes

object

additionalAddressLine

string

Max length: 40

countryCode

required

string

Format([A-Z]{2})
Country code (encoded as 2-letter code according to ISO 3166-1 alpha-2)

postalCode

required

string

Max length: 10

maxLength(10)
Postal code

postalPlace

required

string

Max length: 40

maxLength(40)
Postal place, e.g. city

street

required

string

Max length: 60

maxLength(60)
Name of street or packstation

streetNumber

string

Max length: 10

maxLength(10)
Street or packstation number

firstName

required

string

Max length: 40

maxLength(40)
First name

language

string

Format([a-z]{2})
Language to be used for communication (encoded as 2-letter code according to ISO 639-1 alpha-2)

lastName

required

string

Max length: 40

maxLength(40)
Last name

salutation

required

string

Enum:

MRS

COMPANY

UNDEFINED

Salutation of the (natural or legal) person: * MR = Mr * MRS = Mrs * COMPANY = Company * UNDEFINED = undefined

title

string

Enum:

PROF

PROF_DR

BACHELOR_OF_ARTS

MBA

DOCTOR_OF_PHILOSOPHY

state

string

Max length: 3

maxLength(3)
State. The valid values for this field vary from country to country and must be defined as part of the client onboarding process.

supplyingCountry

required

string

Format([A-Z]{2})
Country of origin of the shipment (encoded as ISO 3166-1 alpha-2)

trackingCode

string

Max length: 32

maxLength(31)
Tracking code of parcel. Required for chargeback handling

vatDeclarationCountry

required

string

Format([A-Z]{2})
Country in which the tax has to be declared (encoded as 2-letter code according to ISO 3166-1 alpha-2)

Responses

array

code

string

Error code.

description

string

Error description.

title

string

Error title.

type

string

Error type.

array

code

string

Error code.

description

string

Error description.

title

string

Error title.

type

string

Error type.

Successful Request for Visa payment

Request Example

    
        {
 "items": [
  {
   "vatType": "NORMAL",
   "quantity": 1,
   "productId": "BEF12346512A/1",
   "vatAmount": 19,
   "vatPercent": 19,
   "description": "Blumentopf XL (GRAU)",
   "positionType": "SALES_ARTICLE",
   "grossUnitPrice": 119,
   "orderItemReference": 1
  }
 ],
 "currency": "EUR",
 "orderDate": "2015-12-10T00:00:00.0000000",
 "orderType": "PHYSICAL_GOODS",
 "orderChannel": "ECOM",
 "billToAddress": {
  "email": "max.mustermann@outlook.com",
  "phone": "+491345789555",
  "title": "DR",
  "careOf": "Jane c/o John",
  "street": "Beispielstr.",
  "language": "de",
  "lastName": "Mustermann",
  "birthDate": "1983-09-15",
  "firstName": "Max",
  "postalCode": "48213",
  "salutation": "MRS",
  "countryCode": "DE",
  "nationality": "DE",
  "postalPlace": "Muenster",
  "streetNumber": "13A",
  "customerGroup": "Gold Clients",
  "taxIdentificationNumber": "DE999999999"
 },
 "shipToAddress": {
  "state": "AL",
  "title": "DR",
  "careOf": "Jane c/o John",
  "street": "Beispielstr.",
  "language": "de",
  "lastName": "Mustermann",
  "firstName": "Max",
  "postalCode": "48213",
  "salutation": "MRS",
  "countryCode": "DE",
  "postalPlace": "Muenster",
  "streetNumber": "13A"
 },
 "orderReference": "ODE12345678901",
 "paymentReference": {
  "paymentDetails": {
   "cardType": "VI",
   "cardHolder": "Max Mustermann",
   "expirationDate": {
    "year": 2018,
    "month": 12
   },
   "authorizedAmount": 119,
   "transactionToken": "8acda4a36b26b30a016b64b7bcd0225c",
   "authorizationDate": "2018-11-05T16:15:03.0000000+00:00",
   "merchantAccountId": "ECOM_WP",
   "settlementReference": "ODE12340849323"
  },
  "paymentMethodName": "VISA"
 },
 "supplyingCountry": "DE",
 "processAfterDunning": "HAND_OVER_FOR_DEBT_COLLECTION",
 "vatDeclarationCountry": "DE"
}

Response Example

    
        {
 "internalRequestId": "23c9579b-baaf-468f-a529-f876226e183c"
}