JSON New Purchase Order [ccb by dsb®

JSON New Purchase Order

Example

{
  "purchaseOrderSource" : "REPLACE",
  "paymentMethod" : null,
  "shippingCostCode" : "0",
  "shippingCost" : null,
  "insuranceCode" : null,
  "insuranceAmount" : null,
  "debitAccountNumber" : null,
  "debitBankCode" : null,
  "debitCountryCode" : null,
  "debitAccountHolder" : null,
  "debitContinuous" : "N",
  "ccNumber" : null,
  "ccCompany" : null,
  "ccChecksum" : null,
  "ccHolder" : null,
  "ccExpiry" : null,
  "ccStartdate" : null,
  "ccIssuenumber" : null,
  "ccType" : null,
  "priceList" : "UK",
  "creditLimitCheck" : null,
  "giftParcel" : null,
  "partDeliveries" : null,
  "purchaseOrderCategory" : null,
  "seriesCode" : null,
  "externalOrderId" : "0000007582",
  "correspondenceLanguageCode" : null,
  "dateOfDelivery" : null,
  "cashHandInLater" : null,
  "iban" : null,
  "bic" : null,
  "depositNumber" : null,
  "cashCurrencyCode" : null,
  "cashAmount" : 0.0,
  "cashInAdvanceCurrencyCode" : null,
  "cashInAdvanceAmount" : 0.0,
  "purchaseOrderPriority" : null,
  "shippingMethod" : null,
  "shippingType" : null,
  "shippingForm" : null,
  "shippingTypeSuffix" : null,
  "dateOfPurchaseOrder" : "2017-03-03",
  "clientHasMoney" : null,
  "option" : null,
  "processingType" : null,
  "variableCode1" : null,
  "variableCode2" : null,
  "dsbEPaymentGuid" : null,
  "preliminaryCancellationCode" : null,
  "purchaseOrderNumber" : null,
  "preliminarySpotId" : null,
  "preliminaryPurchaseOrderSource" : null,
  "purchaseOrderInfo" : null,
  "positions" : [ ],
  "purchaseOrderAttributes" : [ ],
  "paymentType1" : "OB",
  "bpRelations" : [ {
      "role" : "AG",
      "bp" : { ... }
  } ]
}

Element Definitions

Field name	Type	Description
purchaseOrderSource	AN	purchase order source (mandatory)
paymentType1 paymentType2 paymentType3	AN	Payment Type max. 3 external payment types at the same time. paymentType1 is mandatory. For example cash, check, CC, invoice (Coded field; content is declared by the department)
paymentMethod	AN	Payment method
shippingCostCode	AN	Shipping cost code (Coded field; content is declared by the department)
shippingCost	N	Shipping costs usually no entry
insuranceCode	AN	Insurance code (Coded field; content is declared by the department)
insuranceAmount	N	Insurance amount
debitAccountNumber	AN	Account number of debit.
debitBankCode	AN	Bank code of debit
debitCountryCode	AN	country code as ISO country code
debitAccountHolder	AN	Account holder of debit
debitContinuous	AN	Continuous Debit J = Yes Y = Yes (methods with version 2.0.0 or higher) N = No, only once
iban	AN	IBAN
bic	AN	BIC
depositNumber	AN	Deposit number
ccNumber	AN	CC Number
ccChecksum	AN	CC check number
ccCompany	AN	CC-company (Coded field; content is declared by the department)
ccHolder	AN	CC holder
ccExpiry	N	CC expiry YYYYMM
ccStartdate	N	CC startdate YYYYMM
ccIssuenumber	AN	CC issue number
ccType	AN	CC type
priceList	AN	Price List (Coded field; content is declared by the department)
extraPayDiscountList	AN	Surcharge / Discount of item: Surcharge / Discount list (Coded field; content is declared by the department)
extraPayDiscountRate	N	Surcharge / Discount rate (percentage) If discount, sign is minus Planned but not available yet!
extraPayDiscountAmount	N	Surcharge / Discount amount If discount, sign is minus Planned but not available yet!
extraPayDiscountOfPurchaseOrderAmount	N	Surcharge / Discount amount of purchase order If discount, sign is minus Use only after appropval of VHS/3 team.
creditLimitCheck	AN	Credit limit check (Coded field; content is declared by the department)
maximumPurchaseOrderValueCheck	AN	Check max. purchase order value J = test Y = test (methods with Version 2.0.0 or higher) N = no test ‘ ‘ = no declaration (Default value is applied)
minimumPurchaseOrderValueCheck	AN	Check min. purchase order value J = test Y = test (methods with Version 2.0.0 or higher) N = no test ‘ ‘ = no declaration (Default value is applied).)
giftParcel	AN	Gift parcel tag J = gift Y = gift (methods with Version 2.0.0 or higher) N = no gift ‘ ‘ = no declaration (no gift)
partDeliveries	AN	Number of deliveries Values: 0 = unbounded 1 – 9 = according to customer wish ‘ ‘ = no entry (default value)
purchaseOrderCategory	AN	Purchase order category classifies order (e.g. 24h delivery) (Coded field; content is declared by the department)
seriesCode	AN	Code for Sequence and Series processing.
externalOrderId	AN	Purchase order ID Reference to an external purchase order number
correspondenceLanguageCode	N	Correspondence language code Determines in which language the order is processed (e. g. Print) (Coded field; content is declared by the department) (1 = English, 2 = German, more languages )
dateOfDelivery	N	Date of delivery (Format YYYY-MM-TT)
cashHandInLater	AN	Cash hand in later (Coded field; content is declared by the department)
chequeCode	AN	Cheque code
chequeNumber	AN	Cheque number
chequeAccountNumber	AN	Cheque account number
chequeBankCode	AN	Cheque bank code
chequeCountryCode	AN	Cheque country code.
chequeBankName	AN	Cheque bank name
chequeAccountHolder	AN	Cheque account holder
chequeType	AN	Cheque type (Coded field; content is declared by the department)
chequeCurrencyCode	AN	Cheque currency (Coded field; content is declared by the department)
chequeAmount	N	Cheque amount
cashCurrencyCode	AN	Cash currency code (Coded field; content is declared by the department)
cashAmount	N	Cash amount
cashInAdvanceCurrencyCode	AN	Cash in advance currency code (Coded field; content is declared by the department)
cashInAdvanceAmount	N	Cash in advance amount
purchaseOrderPriority	AN	Purchase order priority Controls the processing of the purchase order (Coded field; content is declared by the department)
shippingMethod	AN	Shipping method (Coded field; content is declared by the department) 00 = determined automatically by Back Office
shippingType	AN	Shipping type (Reference to shipping method) (Coded field; content is declared by the department) 00 = determined automatically by Back Office
shippingTypeSuffix	AN	Shipping type suffix empty
shippingForm	AN	Shipping form 00 = no declaration 01 = C. O. D.
dateOfPurchaseOrder	N	Date-of-purchase-order ISO Format
clientHasMoney	N	Client has the money, field for payment amount
option	AN	Option
processingType	AN	Processing Type (only if business-partner is used) 1 = only address 2 = purchase-order (default) 3 = only address but with automatic item assignment 4 = purchase-order with address modification
variableCode1	AN	Field for variable data
variableCode2	AN	Field for variable data
purchaseOrderInfo	AN	Purchase Order Information
dsbEPaymentGuid	AN	Transactions-ID of the authorisation. This is replied in the response of a Notify service.
preliminaryCancellationCode	AN	Preliminary cancellation code of a external system. This is used to signal the VHS/3 that a purchase-order is already canceled and only transferred to the backend system in order to do statistical reporting.
purchaseOrderAttributes
bpRelations
* bpRole	C	business partner role. Business Partner with role AG is mandatory.
* bp		business partner (see below)
positions		purchase order items. At least one item must be sent.

bp

JSON Business Partner

Example

{
    "salutationCode" : "01",
    "lastName1"  : "Y",
    "firstName"  : "X",
    "addressLine1" : "Blitz Media Ltd, Unit 1, Torfaen Bu",
    "zipcode" : "N1C 4AP",
    "countryCode" : "GB",
    "city" : "LONDON",
    "bpCommunicationsList" : [
        {
            "communicationType" : "T",
            "communicationValue" : "123"
        }
    ],
    "bpAttributesList" : [],
    "avsAttributes" : {
	"salesOrganization" : "0100",
	"distributionChannel" : "01",
	"division" : "01"
    }
}

Element Definitions

Field name	Type	Length	Description
bpNumber	C	10	Business partner no.
lastName1	C	35	Lastname 1
lastName2	C	35	Lastname 2
firstName	C	35	First-name
nickName	C	35
jobTitle	C	35	Job title
salutationCode	C	2	Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms.
prefix	C	4
titleCodeAcademic	C	4	Academic title code, e.g. 0027 = Dr
titleAcademic	C	15	Academic Title, e.g. Dr.
titleCodeRoyal	C	4	Royal title code
titleRoyal	C	15	Royal title
company1	C	40	1. line of company address. If this field is filled is the above name the contact person of the firm.
company2	C	40	2. line of company address. Contains for example section or continuation of firm address.
company3	C	40	3. line of company address
department	C	30	department
zipcode	C	10	zipcode
street	C	50	Street with house no. and addition to house no.
streetSuffix	C	40	Addition to street
streetNumber	C	10	Street Number
streetNumberSuffix	C	10	Street Number Suffix
addressLine1	C	35	Address line 1 for UK addresses
addressLine2	C	35	Address line 2 for UK addresses
addressLine3	C	35	Address line 3 for UK addresses
poBoxZipcode	C	10	Po-box-zipcode
poBox	C	10	Po-box
poBoxCity	C	40	Po-box-city
poBoxCountryCode	C	2	Po-box-country-code
majorCustomerZipcode	C	10	Major-cust-zip
city	C	40	City
district	C	40	Addition of city
regionCode	C	3	Region-Code (federal state, province, county)
regionText	C	25	Region as cleartext (e.g. County…)
countryCode	C	2	Two letter ISO 3166-1 alpha-2 country-code
advertisement	C	1	Advertisement permitted; Y / N
block	B		General block-tag
blockReason	C	2	block reason
euSalesTaxNumber	C	14	EU sales tax id
addressSource	C	10	source of the address
dateOfBirth	D		Birthdate (YYYY-MM-DD)
masterNumber	C	10	Partner-ID of master (for example company of contact person)
sector	C	10	branch
bpCommunicationsList
communicationType	C	2	Communication Types; Values
communicationValue	C	50	Communication value
communicationDefault	C	1	Default value Y / N
avsAttributes
salesOrganization	C	4	(mandatory)
distributionChannel	C	2	(mandatory)
division	C	2	(mandatory)

bpAttributesList

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

purchaseOrderAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value

positions

JSON Purchase Order Items

Example

{
    "purchaseOrderQuantity" : 1.0,
    "posNumber" : null,
    "distributionArticleNumber": "AB12345",
    "distArticleDescription1" : null,
    "price" : null,
    "priceUnit" : 0,
    "extraPayDiscountList" : null,
    "extraPayDiscountRate" : null,
    "extraPayDiscountAmount" : null,
    "shippingMethod" : null,
    "shippingType" : null,
    "shippingForm" : null,
    "shippingCostOfItem" : null,
    "wrappingPaperCode" : null,
    "itemAttributes" : [ ]
  }

Element Definitions

Field name	Type	Description
distributionArticleNumber	AN	Distribution article number / Sales article number (mandatory)
distributionArticleNumberExternal	AN	external distribution article number / Sales article number
purchaseOrderQuantity	N	Purchase order quantity
posNumber	N	External position number of this item, which should be used instead of the VHS/3 position number. This number must be unique over all positions of a purchase-order.
price	N	Price (Single price or special price)
priceUnit	N	Price unit
freeOfCharge	BOOL	Free of charge tag
extraPayDiscountList	AN	Surcharge / Discount Surcharge / Discount list (Coded field; content is declared by the department)
extraPayDiscountRate	N	Surcharge / Discount rate (percentage) If discount, sign is minus
extraPayDiscountAmount	N	Surcharge / Discount amount If discount, sign is minus
shippingMethod shippingType shippingForm	AN AN AN	Extra shipping of article (Coded field; content is declared by the department) usually empty Shipping method Shipping type Shipping form
shippingCostOfItem	N	Shipping costs of the item
wrappingPaperCode	AN	Assignment of the gift wrap
itemAttributes

itemAttributes

JSON Attributes

Example

 {
    "type": "ABC",
    "value": "2876201a9b0b5173b5d436464b9c7a2b"
 }

Element Definitions

Field name	Type	Description
type	C	type of attribute
value	C	attribute value