Middleware
In order to baseline data from a system of record, an interface must be created to interact with Provide Baseline. The integration interface serves as a bi-directional implementation layer that enables seamless interaction between the system of record and Provide Baseline.
In order to successfully interact with Provide Baseline, the integration interface must support the following functions:
Name
Description
ConfigureProxy
sets the organization parameters for baselining a record
CreateObject
creates a Baseline object
GetObjectModel
retrieves the object
model
UpdateObject
updates a target object
UpdateObjectStatus
updates the status of a target object
type SOR interface {
ConfigureProxy(params map[string]interface{}) error
CreateObject(params map[string]interface{}) (interface{}, error)
DeleteProxyConfiguration(organizationID string) error
GetObjectModel(recordType string, params map[string]interface{}) (interface{}, error)
HealthCheck() error
ProxyHealthCheck(organizationID string) error
UpdateObject(id string, params map[string]interface{}) error
UpdateObjectStatus(id string, params map[string]interface{}) error
}
Configuring Middleware
First, you'll need to configure the system of record with information about the middleware to facilitate a connection. The model that the system of record must ingest is contained in the request below:
Configure Middleware
POST
https://example.sor.local/proxy_config
Initializes a connection with middleware; URL will vary based on system of record implementation
Request Body
ident_endpoint
string
base URL of the Ident service being configured for the tenant
organization_id
string
id
of the organization being configured for the tenant
proxy_endpoint
string
based URL of the middleware being configured for the tenant
refresh_token
string
long-lived bearer token used to authorize access tokens for use with middleware
Creating an Object
A Baseline Object
is arbitrary data containing the ProtocolMessagePayload
. The integration middleware will need to pass this object in accordance with the domain model as agreed upon by the counter-parties and enforced by a prover. The middleware will ingest the ProtocolMessagePayload
, return a BaselineRecord
, and output a ProtocolMessage
to participant middlewares.
Create Object
POST
https://baseline.provide.services/api/v1/objects
Creates a baseline Object
Headers
authorization*
string
bearer <JWT> scoped for an Organization
Request Body
object
object
arbitrary data that holds the ProtocolMessagePayload
type
string
type of circuit being used; currently this should be set to general_consistency
payload
string
public and private inputs used to generate the proof; payload
can be delivered as a JSON object or chunked and streamed.
id
string
arbitrary identifier intended for use by external systems of record
{
"id": "16e9755c-68bf-455f-b662-d383104cc715",
"baseline_id": "15679071-4a5e-41e3-a495-5d93b478257b",
"opcode": "BLINE",
"payload": {
"proof": "8d8f7498db7aee910428c737d8427ac4add98353f981ca70db07697a091d8c23972b55b0b20fc0eebc1ac6c2ae427d783291c7fcb2e3f7417d279fea78ce1eac2d2293e53579abbef4960a1e290bd023e2999d8ff423d01080d449ce5d14ca89c94e277e8e0bb14fb91a0b71129920ae4411e77685287611f4d2aaf66b8fc5dc",
"type": "general_consistency",
"witness": {}
},
"type": "general_consistency"
}
Deleting a Proxy Configuration
In the DevOps lifecycle, it may become necessary to delete a configured middleware on behalf of a tenant. In these cases, the system of record will need to stop sending requests to the middleware associated with the specified organization_id
.
Delete Middleware Configuration
DELETE
https://example.sor.local/organizations/:id/proxy
Deletes a specified proxy configuration
Path Parameters
id
string
id
of Organization
related to middleware requiring deletion
Fetching the Object Schema
Because the payload
contained within the object
supports arbitrary data, it may be necessary to query the stack to retrieve the schema of the object model being used.
Fetch Object Schemas
GET
https://baseline.provide.services/api/v1/object_schemas
Returns a list of object schemas within the authorized scope
Query Parameters
type
string
name of DomainModel
{
"idoc_type": "INVOIC01",
"schema": {
"type": "object",
"description": "",
"properties": {
"control": {
"type": "object",
"description": "EDI_DC40",
"properties": {
"tabnam": {
"type": "string",
"format": "EDI4TABNAM",
"description": "Table",
"maxlength": "10"
},
"mandt": {
"type": "string",
"format": "EDI4MANDT",
"description": "Client",
"maxlength": "3"
},
"docnum": {
"type": "string",
"format": "EDI4DOCNUC",
"description": "IDoc number",
"maxlength": "16"
},
"docrel": {
"type": "string",
"format": "EDI4DOCREL",
"description": "SAP Release for IDoc",
"maxlength": "4"
},
"status": {
"type": "string",
"format": "EDI4STATUS",
"description": "Status",
"maxlength": "2"
},
"direct": {
"type": "string",
"format": "EDI4DIRECT",
"description": "Directn",
"maxlength": "1"
},
"outmod": {
"type": "string",
"format": "EDI4OUTMOD",
"description": "OutpMod",
"maxlength": "1"
},
"exprss": {
"type": "string",
"format": "EDI4EXPRSS",
"description": "Express",
"maxlength": "1"
},
"test": {
"type": "string",
"format": "EDI4TEST",
"description": "Test",
"maxlength": "1"
},
"idoctyp": {
"type": "string",
"format": "EDI4IDOCTP",
"description": "Basic type",
"maxlength": "30"
},
"cimtyp": {
"type": "string",
"format": "EDI4CIMTYP",
"description": "Extension",
"maxlength": "30"
},
"mestyp": {
"type": "string",
"format": "EDI4MESTYP",
"description": "Message type",
"maxlength": "30"
},
"mescod": {
"type": "string",
"format": "EDI4MESCOD",
"description": "Message code",
"maxlength": "3"
},
"mesfct": {
"type": "string",
"format": "EDI4MESFCT",
"description": "Message Function",
"maxlength": "3"
},
"std": {
"type": "string",
"format": "EDI4STD",
"description": "EDI Standard",
"maxlength": "1"
},
"stdvrs": {
"type": "string",
"format": "EDI4STDVRS",
"description": "Version of EDI standard",
"maxlength": "6"
},
"stdmes": {
"type": "string",
"format": "EDI4STDMES",
"description": "EDI message type",
"maxlength": "6"
},
"sndpor": {
"type": "string",
"format": "EDI4SNDPOR",
"description": "Sender port",
"maxlength": "10"
},
"sndprt": {
"type": "string",
"format": "EDI4SNDPRT",
"description": "Partn.Type",
"maxlength": "2"
},
"sndpfc": {
"type": "string",
"format": "EDI4SNDPFC",
"description": "Sender partner function",
"maxlength": "2"
},
"sndprn": {
"type": "string",
"format": "EDI4SNDPRN",
"description": "Partner number",
"maxlength": "10"
},
"sndsad": {
"type": "string",
"format": "EDI4SNDSAD",
"description": "Sender addr.(SADR)",
"maxlength": "21"
},
"sndlad": {
"type": "string",
"format": "EDI4SNDLAD",
"description": "Logical address of sender",
"maxlength": "70"
},
"rcvpor": {
"type": "string",
"format": "EDI4RCVPOR",
"description": "Receiver port",
"maxlength": "10"
},
"rcvprt": {
"type": "string",
"format": "EDI4RCVPRT",
"description": "Part. Type",
"maxlength": "2"
},
"rcvpfc": {
"type": "string",
"format": "EDI4RCVPFC",
"description": "Partner Role",
"maxlength": "2"
},
"rcvprn": {
"type": "string",
"format": "EDI4RCVPRN",
"description": "Partner Number",
"maxlength": "10"
},
"rcvsad": {
"type": "string",
"format": "EDI4RCVSAD",
"description": "Rec. address (SADR)",
"maxlength": "21"
},
"rcvlad": {
"type": "string",
"format": "EDI4RCVLAD",
"description": "Logical Address of Receiver",
"maxlength": "70"
},
"credat": {
"type": "string",
"format": "date YYYYMMDD EDI4CREDAT",
"description": "Created On",
"maxlength": "10"
},
"cretim": {
"type": "string",
"format": "time HHMMSS EDI4CRETIM",
"description": "Created at",
"maxlength": "8"
},
"refint": {
"type": "string",
"format": "EDI4REFINT",
"description": "Transmission",
"maxlength": "14"
},
"refgrp": {
"type": "string",
"format": "EDI4REFGRP",
"description": "MessageGrp",
"maxlength": "14"
},
"refmes": {
"type": "string",
"format": "EDI4REFMES",
"description": "EDI message",
"maxlength": "14"
},
"arckey": {
"type": "string",
"format": "EDI4ARCKEY",
"description": "Key for external message archive",
"maxlength": "70"
},
"serial": {
"type": "string",
"format": "EDI4SERIAL",
"description": "Serialization",
"maxlength": "20"
}
}
},
"data": {
"type": "object",
"description": "",
"properties": {
"e1edk01": {
"type": "object",
"description": "",
"properties": {
"action": {
"type": "string",
"description": "",
"maxlength": "3"
},
"kzabs": {
"type": "string",
"description": "",
"maxlength": "1"
},
"curcy": {
"type": "string",
"description": "",
"maxlength": "3"
},
"hwaer": {
"type": "string",
"description": "",
"maxlength": "3"
},
"wkurs": {
"type": "string",
"description": "",
"maxlength": "12"
},
"zterm": {
"type": "string",
"description": "",
"maxlength": "17"
},
"kundeuinr": {
"type": "string",
"description": "",
"maxlength": "20"
},
"eigenuinr": {
"type": "string",
"description": "",
"maxlength": "20"
},
"bsart": {
"type": "string",
"description": "",
"maxlength": "4"
},
"belnr": {
"type": "string",
"description": "",
"maxlength": "35"
},
"ntgew": {
"type": "string",
"description": "",
"maxlength": "18"
},
"brgew": {
"type": "string",
"description": "",
"maxlength": "18"
},
"gewei": {
"type": "string",
"description": "",
"maxlength": "3"
},
"fkart_rl": {
"type": "string",
"description": "",
"maxlength": "4"
},
"ablad": {
"type": "string",
"description": "",
"maxlength": "25"
},
"bstzd": {
"type": "string",
"description": "",
"maxlength": "4"
},
"vsart": {
"type": "string",
"description": "",
"maxlength": "2"
},
"vsart_bez": {
"type": "string",
"description": "",
"maxlength": "20"
},
"recipnt_no": {
"type": "string",
"description": "",
"maxlength": "10"
},
"kzazu": {
"type": "string",
"description": "",
"maxlength": "1"
},
"autlf": {
"type": "string",
"description": "",
"maxlength": "1"
},
"augru": {
"type": "string",
"description": "",
"maxlength": "3"
},
"augru_bez": {
"type": "string",
"description": "",
"maxlength": "40"
},
"abrvw": {
"type": "string",
"description": "",
"maxlength": "3"
},
"abrvw_bez": {
"type": "string",
"description": "",
"maxlength": "20"
},
"fktyp": {
"type": "string",
"description": "",
"maxlength": "1"
},
"lifsk": {
"type": "string",
"description": "",
"maxlength": "2"
},
"lifsk_bez": {
"type": "string",
"description": "",
"maxlength": "20"
},
"empst": {
"type": "string",
"description": "",
"maxlength": "25"
},
"abtnr": {
"type": "string",
"description": "",
"maxlength": "4"
},
"delco": {
"type": "string",
"description": "",
"maxlength": "3"
},
"wkurs_m": {
"type": "string",
"description": "",
"maxlength": "12"
},
"landtx": {
"type": "string",
"description": "",
"maxlength": "3"
},
"stceg_l": {
"type": "string",
"description": "",
"maxlength": "3"
}
}
},
"e1edka1": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"parvw": {
"type": "string",
"format": "EDI3035_A",
"description": "Role",
"maxlength": "3"
},
"partn": {
"type": "string",
"format": "PARTNER",
"description": "Partner",
"maxlength": "17"
},
"lifnr": {
"type": "string",
"format": "LIFNR_ED1",
"description": "Supplier",
"maxlength": "17"
},
"name1": {
"type": "string",
"format": "EDI3036_A",
"description": "Name 1",
"maxlength": "35"
},
"name2": {
"type": "string",
"format": "EDI3036_B",
"description": "Name 2",
"maxlength": "35"
},
"name3": {
"type": "string",
"format": "EDI3036_C",
"description": "Name 3",
"maxlength": "35"
},
"name4": {
"type": "string",
"format": "EDI3036_D",
"description": "Name 4",
"maxlength": "35"
},
"stras": {
"type": "string",
"format": "EDI3042_A",
"description": "Street and house number 1",
"maxlength": "35"
},
"strs2": {
"type": "string",
"format": "EDI3042_C",
"description": "Street and house number 2",
"maxlength": "35"
},
"pfach": {
"type": "string",
"format": "EDI3042_B",
"description": "PO Box",
"maxlength": "35"
},
"ort01": {
"type": "string",
"format": "EDI3164_A",
"description": "City",
"maxlength": "35"
},
"counc": {
"type": "string",
"format": "EDI3229_A",
"description": "County code",
"maxlength": "9"
},
"pstlz": {
"type": "string",
"format": "EDI3251_A",
"description": "Postal code",
"maxlength": "9"
},
"pstl2": {
"type": "string",
"format": "EDI3251_B",
"description": "PO Box pcd",
"maxlength": "9"
},
"land1": {
"type": "string",
"format": "EDI3207_A",
"description": "Ctry",
"maxlength": "3"
},
"ablad": {
"type": "string",
"format": "EDI3224LA",
"description": "Unloading Point",
"maxlength": "35"
},
"pernr": {
"type": "string",
"format": "EDI3413LB",
"description": "Pers. No.",
"maxlength": "30"
},
"parnr": {
"type": "string",
"format": "EDI3413LC",
"description": "Contact",
"maxlength": "30"
},
"telf1": {
"type": "string",
"format": "EDI3148_A",
"description": "Telephone Number",
"maxlength": "25"
},
"telf2": {
"type": "string",
"format": "EDI3148_B",
"description": "Telephone 2",
"maxlength": "25"
},
"telbx": {
"type": "string",
"format": "EDI3148_C",
"description": "Telebox",
"maxlength": "25"
},
"telfx": {
"type": "string",
"format": "EDI3148_D",
"description": "Fax number",
"maxlength": "25"
},
"teltx": {
"type": "string",
"format": "EDI3148_E",
"description": "Teletex no.",
"maxlength": "25"
},
"telx1": {
"type": "string",
"format": "EDI3148_F",
"description": "Telex number",
"maxlength": "25"
},
"spras": {
"type": "string",
"format": "EDI_SPRAS",
"description": "L",
"maxlength": "1"
},
"anred": {
"type": "string",
"format": "EDI_ANRED",
"description": "Form of address",
"maxlength": "15"
},
"ort02": {
"type": "string",
"format": "EDI_ORT02",
"description": "District",
"maxlength": "35"
},
"hausn": {
"type": "string",
"format": "EDI_HAUSN",
"description": "House#",
"maxlength": "6"
},
"stock": {
"type": "string",
"format": "EDI_STOCK",
"description": "Floor",
"maxlength": "6"
},
"regio": {
"type": "string",
"format": "EDI_REGIO",
"description": "Reg",
"maxlength": "3"
},
"parge": {
"type": "string",
"format": "EDI_PARGE",
"description": "G",
"maxlength": "1"
},
"isoal": {
"type": "string",
"format": "INTCA",
"description": "ISO code",
"maxlength": "2"
},
"isonu": {
"type": "string",
"format": "INTCA",
"description": "ISO code",
"maxlength": "2"
},
"fcode": {
"type": "string",
"format": "EDI_FCODE",
"description": "Company key - France",
"maxlength": "20"
},
"ihrez": {
"type": "string",
"format": "EDI3413LA",
"description": "Your reference",
"maxlength": "30"
},
"bname": {
"type": "string",
"format": "EDI_BNAME",
"description": "User Name",
"maxlength": "35"
},
"paorg": {
"type": "string",
"format": "EDI_PAORG",
"description": "Org.code",
"maxlength": "30"
},
"orgtx": {
"type": "string",
"format": "EDI_ORGTX",
"description": "Text",
"maxlength": "35"
},
"pagru": {
"type": "string",
"format": "EDI_PAGRU",
"description": "Group code",
"maxlength": "30"
},
"knref": {
"type": "string",
"format": "KNREF",
"description": "Part",
"maxlength": "30"
},
"ilnnr": {
"type": "string",
"format": "CHAR70",
"description": "Char 70",
"maxlength": "70"
},
"pfort": {
"type": "string",
"description": "",
"maxlength": "35"
},
"spras_iso": {
"type": "string",
"description": "",
"maxlength": "2"
},
"title": {
"type": "string",
"description": "",
"maxlength": "15"
}
}
}
},
"e1edk02": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"qualf": {
"type": "string",
"format": "EDI_QUALFR",
"description": "Qualifier",
"maxlength": "3"
},
"belnr": {
"type": "string",
"format": "EDI_BELNR",
"description": "Document",
"maxlength": "35"
},
"posnr": {
"type": "string",
"format": "EDI1082_A",
"description": "DocItm",
"maxlength": "6"
},
"datum": {
"type": "string",
"format": "EDIDAT8",
"description": "Date",
"maxlength": "8"
},
"uzeit": {
"type": "string",
"format": "EDITIM6",
"description": "Time",
"maxlength": "6"
}
}
}
},
"e1edk03": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"iddat": {
"type": "string",
"format": "EDI_IDDAT",
"description": "Qualifier",
"maxlength": "3"
},
"datum": {
"type": "string",
"format": "EDIDAT8",
"description": "Date",
"maxlength": "8"
},
"uzeit": {
"type": "string",
"format": "EDITIM6",
"description": "Time",
"maxlength": "6"
}
}
}
},
"e1edk05": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"alckz": {
"type": "string",
"format": "EDI5463_A",
"description": "Sign",
"maxlength": "3"
},
"kschl": {
"type": "string",
"format": "EDI5189_A",
"description": "Condition type",
"maxlength": "4"
},
"kotxt": {
"type": "string",
"format": "EDI1230LA",
"description": "Condition text",
"maxlength": "80"
},
"betrg": {
"type": "string",
"format": "EDI5004_P",
"description": "Fixed sur./disc.",
"maxlength": "18"
},
"kperc": {
"type": "string",
"format": "EDI5482_C",
"description": "Percent",
"maxlength": "8"
},
"krate": {
"type": "string",
"format": "EDI5420_A",
"description": "Condition record",
"maxlength": "15"
},
"uprbs": {
"type": "string",
"format": "EDI5284_A",
"description": "per",
"maxlength": "9"
},
"meaun": {
"type": "string",
"format": "EDI6411_F",
"description": "Unit of measurement",
"maxlength": "3"
},
"kobtr": {
"type": "string",
"format": "EDI_KOBTR",
"description": "Amount",
"maxlength": "18"
},
"mwskz": {
"type": "string",
"format": "EDI5279_A",
"description": "VAT indicator",
"maxlength": "7"
},
"msatz": {
"type": "string",
"format": "EDI5278_A",
"description": "VAT rate",
"maxlength": "17"
},
"koein": {
"type": "string",
"description": "",
"maxlength": "3"
}
}
}
},
"e1edk04": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"mwskz": {
"type": "string",
"format": "EDI5279_A",
"description": "VAT indicator",
"maxlength": "7"
},
"msatz": {
"type": "string",
"format": "EDI5278_A",
"description": "VAT rate",
"maxlength": "17"
},
"mwsbt": {
"type": "string",
"format": "EDI5004_O",
"description": "VAT amount",
"maxlength": "18"
},
"txjcd": {
"type": "string",
"format": "TXJCD",
"description": "Tax Jur.",
"maxlength": "15"
},
"ktext": {
"type": "string",
"description": "",
"maxlength": "50"
}
}
}
},
"e1edk17": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"qualf": {
"type": "string",
"format": "EDI_QUALFF",
"description": "Qualifier",
"maxlength": "3"
},
"lkond": {
"type": "string",
"format": "EDI_LKOND",
"description": "Dlv.condition",
"maxlength": "3"
},
"lktext": {
"type": "string",
"format": "EDI_LKTEXT",
"description": "Text",
"maxlength": "70"
}
}
}
},
"e1edk18": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"qualf": {
"type": "string",
"format": "EDI_QUALFZ",
"description": "Qualifier",
"maxlength": "3"
},
"tage": {
"type": "string",
"format": "EDI_TAGE",
"description": "Days",
"maxlength": "8"
},
"prznt": {
"type": "string",
"format": "EDI_PRZNT",
"description": "Percentage",
"maxlength": "8"
},
"zterm_txt": {
"type": "string",
"format": "EDI4040_A",
"description": "Text line",
"maxlength": "70"
}
}
}
},
"e1edk23": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"qualf": {
"type": "string",
"format": "QUALIWAERS",
"description": "Qualifier",
"maxlength": "3"
},
"waerz": {
"type": "string",
"format": "EDI6345_A",
"description": "Curr.",
"maxlength": "3"
},
"waerq": {
"type": "string",
"format": "EDI6345_A",
"description": "Curr.",
"maxlength": "3"
},
"kurs": {
"type": "string",
"format": "EDI5402_A",
"description": "Exch.rate",
"maxlength": "12"
},
"datum": {
"type": "string",
"format": "EDIDAT8",
"description": "Date",
"maxlength": "8"
},
"zeit": {
"type": "string",
"format": "EDITIM6",
"description": "Time",
"maxlength": "6"
},
"kurs_m": {
"type": "string",
"description": "",
"maxlength": "12"
}
}
}
},
"e1edk28": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"bcoun": {
"type": "string",
"format": "EDI3207_A",
"description": "Ctry",
"maxlength": "3"
},
"brnum": {
"type": "string",
"format": "EDI3434_A",
"description": "Bank number",
"maxlength": "17"
},
"bname": {
"type": "string",
"format": "EDI3432_A",
"description": "Bank name",
"maxlength": "70"
},
"baloc": {
"type": "string",
"format": "EDI3436_A",
"description": "Location of bank",
"maxlength": "70"
},
"acnum": {
"type": "string",
"format": "EDI3194LA",
"description": "Account number",
"maxlength": "30"
},
"acnam": {
"type": "string",
"format": "EDI3192_A",
"description": "Account holder",
"maxlength": "35"
},
"biban": {
"type": "string",
"description": "",
"maxlength": "34"
}
}
}
},
"e1edk29": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"exnum": {
"type": "string",
"format": "EXNUM",
"description": "Number",
"maxlength": "10"
},
"aland": {
"type": "string",
"format": "ALAND",
"description": "Ctry",
"maxlength": "3"
},
"expvz": {
"type": "string",
"format": "EXPVZ",
"description": "MoT",
"maxlength": "1"
},
"zolla": {
"type": "string",
"format": "DZOLLS",
"description": "CustOf",
"maxlength": "6"
},
"zollb": {
"type": "string",
"format": "DZOLLB",
"description": "OfDest",
"maxlength": "6"
},
"zoll1": {
"type": "string",
"format": "DZOLL1",
"description": "CustomsOff.1",
"maxlength": "6"
},
"zoll2": {
"type": "string",
"format": "DZOLL2",
"description": "CustomsOff.2",
"maxlength": "6"
},
"zoll3": {
"type": "string",
"format": "DZOLL3",
"description": "CustomsOff.3",
"maxlength": "6"
},
"zoll4": {
"type": "string",
"format": "DZOLL4",
"description": "CustomsOff.4",
"maxlength": "6"
},
"zoll5": {
"type": "string",
"format": "DZOLL5",
"description": "CustomsOff.5",
"maxlength": "6"
},
"zoll6": {
"type": "string",
"format": "DZOLL6",
"description": "CustomsOff.6",
"maxlength": "6"
},
"kzgbe": {
"type": "string",
"format": "KZGBE",
"description": "Id Means of Transport Border",
"maxlength": "30"
},
"kzabe": {
"type": "string",
"format": "KZABE",
"description": "Id Means of Transport Inland",
"maxlength": "30"
},
"stgbe": {
"type": "string",
"format": "STGBE",
"description": "Country MT",
"maxlength": "3"
},
"stabe": {
"type": "string",
"format": "STABE",
"description": "Country MT",
"maxlength": "3"
},
"conta": {
"type": "string",
"format": "CONTA",
"description": "Cont",
"maxlength": "1"
},
"grwcu": {
"type": "string",
"format": "GRWCU",
"description": "Curr.",
"maxlength": "5"
},
"grwrt": {
"type": "string",
"format": "EDI_SUMME",
"description": "Overall",
"maxlength": "18"
},
"land1": {
"type": "string",
"format": "LAND1",
"description": "Ctr",
"maxlength": "3"
},
"landx": {
"type": "string",
"format": "LANDX",
"description": "Name",
"maxlength": "15"
},
"landa": {
"type": "string",
"format": "LANDA",
"description": "Alternative Key",
"maxlength": "3"
},
"xegld": {
"type": "string",
"format": "XEGLD",
"description": "E",
"maxlength": "1"
},
"freih": {
"type": "string",
"format": "FREIH",
"description": "Free Trade Area",
"maxlength": "1"
},
"ewrco": {
"type": "string",
"format": "EWRCO",
"description": "EEA",
"maxlength": "1"
},
"usc05": {
"type": "string",
"format": "USC05",
"description": "SchedCCode",
"maxlength": "5"
},
"jap05": {
"type": "string",
"format": "JAP05",
"description": "MITI code",
"maxlength": "5"
},
"alanx": {
"type": "string",
"format": "LANDX",
"description": "Name",
"maxlength": "15"
},
"alana": {
"type": "string",
"format": "LANDA",
"description": "Alternative Key",
"maxlength": "3"
},
"lasta": {
"type": "string",
"format": "LANDA",
"description": "Alternative Key",
"maxlength": "3"
},
"lastg": {
"type": "string",
"format": "LANDA",
"description": "Alternative Key",
"maxlength": "3"
},
"alsch": {
"type": "string",
"format": "LANDA",
"description": "Alternative Key",
"maxlength": "3"
},
"alsre": {
"type": "string",
"format": "CHAR5",
"description": "R2tab",
"maxlength": "5"
},
"ladeo": {
"type": "string",
"format": "LADEO",
"description": "Place of load.",
"maxlength": "15"
},
"iever": {
"type": "string",
"format": "IEVER",
"description": "DoModeOfT",
"maxlength": "1"
},
"banr01": {
"type": "string",
"format": "CHAR16",
"description": "",
"maxlength": "16"
},
"banr02": {
"type": "string",
"format": "CHAR03",
"description": "Not used",
"maxlength": "3"
},
"banr03": {
"type": "string",
"format": "CHAR07",
"description": "",
"maxlength": "7"
},
"banr04": {
"type": "string",
"format": "CHAR07",
"description": "",
"maxlength": "7"
},
"banr05": {
"type": "string",
"format": "CHAR07",
"description": "",
"maxlength": "7"
},
"banr06": {
"type": "string",
"format": "CHAR07",
"description": "",
"maxlength": "7"
},
"banr07": {
"type": "string",
"format": "CHAR07",
"description": "",
"maxlength": "7"
},
"banr08": {
"type": "string",
"format": "CHAR07",
"description": "",
"maxlength": "7"
},
"banr09": {
"type": "string",
"format": "CHAR03",
"description": "Not used",
"maxlength": "3"
},
"banr10": {
"type": "string",
"format": "CHAR08",
"description": "",
"maxlength": "8"
},
"wzocu": {
"type": "string",
"description": "",
"maxlength": "5"
},
"expvztx": {
"type": "string",
"description": "",
"maxlength": "20"
},
"zollatx": {
"type": "string",
"description": "",
"maxlength": "30"
},
"zollbtx": {
"type": "string",
"description": "",
"maxlength": "30"
},
"stgbetx": {
"type": "string",
"description": "",
"maxlength": "15"
},
"stabetx": {
"type": "string",
"description": "",
"maxlength": "15"
},
"freihtx": {
"type": "string",
"description": "",
"maxlength": "20"
},
"ladel": {
"type": "string",
"description": "",
"maxlength": "40"
},
"text1": {
"type": "string",
"description": "",
"maxlength": "40"
},
"text2": {
"type": "string",
"description": "",
"maxlength": "40"
},
"text3": {
"type": "string",
"description": "",
"maxlength": "40"
},
"gbnum": {
"type": "string",
"description": "",
"maxlength": "20"
},
"regnr": {
"type": "string",
"description": "",
"maxlength": "20"
},
"ausfu": {
"type": "string",
"description": "",
"maxlength": "10"
},
"iever_tx": {
"type": "string",
"description": "",
"maxlength": "20"
},
"lazl1": {
"type": "string",
"description": "",
"maxlength": "3"
},
"lazl2": {
"type": "string",
"description": "",
"maxlength": "3"
},
"lazl3": {
"type": "string",
"description": "",
"maxlength": "3"
},
"lazl4": {
"type": "string",
"description": "",
"maxlength": "3"
},
"lazl5": {
"type": "string",
"description": "",
"maxlength": "3"
},
"lazl6": {
"type": "string",
"description": "",
"maxlength": "3"
},
"azoll": {
"type": "string",
"description": "",
"maxlength": "6"
},
"azolltx": {
"type": "string",
"description": "",
"maxlength": "30"
},
"bfmar": {
"type": "string",
"description": "",
"maxlength": "6"
},
"ftvbd": {
"type": "string",
"description": "",
"maxlength": "1"
},
"cudcl": {
"type": "string",
"description": "",
"maxlength": "3"
},
"ftupd": {
"type": "string",
"description": "",
"maxlength": "1"
}
}
}
},
"e1edkt1": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"tdid": {
"type": "string",
"format": "EDI4451_A",
"description": "ID",
"maxlength": "4"
},
"tsspras": {
"type": "string",
"format": "EDI3453_A",
"description": "LG",
"maxlength": "3"
},
"tsspras_iso": {
"type": "string",
"description": "",
"maxlength": "2"
},
"tdobject": {
"type": "string",
"description": "",
"maxlength": "10"
},
"tdobname": {
"type": "string",
"description": "",
"maxlength": "70"
},
"e1edkt2": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"tdline": {
"type": "string",
"format": "EDI4040_A",
"description": "Text line",
"maxlength": "70"
},
"tdformat": {
"type": "string",
"description": "",
"maxlength": "2"
}
}
}
}
}
}
},
"e1edk14": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"qualf": {
"type": "string",
"format": "EDI_QUALFO",
"description": "Qualifier",
"maxlength": "3"
},
"orgid": {
"type": "string",
"format": "EDI_ORGID",
"description": "Organization",
"maxlength": "35"
}
}
}
},
"e1edp01": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"posex": {
"type": "string",
"format": "EDI1082_A",
"description": "DocItm",
"maxlength": "6"
},
"action": {
"type": "string",
"format": "EDI1229_A",
"description": "Act",
"maxlength": "3"
},
"pstyp": {
"type": "string",
"format": "PSTYP_EDI",
"description": "P",
"maxlength": "1"
},
"kzabs": {
"type": "string",
"format": "EDI_KZABS",
"description": "O",
"maxlength": "1"
},
"menge": {
"type": "string",
"format": "EDI_MENGE",
"description": "Quantity",
"maxlength": "15"
},
"menee": {
"type": "string",
"format": "EDI_MENEE",
"description": "Unit of measure",
"maxlength": "3"
},
"bmng2": {
"type": "string",
"format": "EDI_BMNG2",
"description": "Quantity",
"maxlength": "15"
},
"pmene": {
"type": "string",
"format": "EDI6411_B",
"description": "PME",
"maxlength": "3"
},
"abftz": {
"type": "string",
"format": "EDI_ABFTZ",
"description": "Cum.qty",
"maxlength": "7"
},
"vprei": {
"type": "string",
"format": "EDI5118_A",
"description": "Net price",
"maxlength": "15"
},
"peinh": {
"type": "string",
"format": "EDI5284_A",
"description": "per",
"maxlength": "9"
},
"netwr": {
"type": "string",
"format": "EDI5004_D",
"description": "Net item value",
"maxlength": "18"
},
"anetw": {
"type": "string",
"format": "EDI5004_R",
"description": "Abs. net value",
"maxlength": "18"
},
"skfbp": {
"type": "string",
"format": "EDI5004_E",
"description": "Cash disc. qualified",
"maxlength": "18"
},
"ntgew": {
"type": "string",
"format": "EDI6314_A",
"description": "Net weight",
"maxlength": "18"
},
"gewei": {
"type": "string",
"format": "EDI6411_D",
"description": "WUn",
"maxlength": "3"
},
"einkz": {
"type": "string",
"format": "EINKZ_EDI",
"description": "S",
"maxlength": "1"
},
"curcy": {
"type": "string",
"format": "EDI6345_A",
"description": "Curr.",
"maxlength": "3"
},
"preis": {
"type": "string",
"format": "EDI5004_F",
"description": "Gross price",
"maxlength": "18"
},
"matkl": {
"type": "string",
"format": "EDI_MATKL",
"description": "Material class",
"maxlength": "9"
},
"uepos": {
"type": "string",
"format": "UEPOS_EDI",
"description": "HgLvIt",
"maxlength": "6"
},
"grkor": {
"type": "string",
"format": "GRKOR_EDI",
"description": "DGr",
"maxlength": "3"
},
"evers": {
"type": "string",
"format": "EDI7065_A",
"description": "SI",
"maxlength": "7"
},
"bpumn": {
"type": "string",
"format": "CHAR6",
"description": "Reserve",
"maxlength": "6"
},
"bpumz": {
"type": "string",
"format": "CHAR6",
"description": "Reserve",
"maxlength": "6"
},
"abgru": {
"type": "string",
"format": "ABGRU_VA",
"description": "Rj",
"maxlength": "2"
},
"abgrt": {
"type": "string",
"format": "BEZEI40",
"description": "Description",
"maxlength": "40"
},
"antlf": {
"type": "string",
"format": "CHAR1",
"description": "",
"maxlength": "1"
},
"fixmg": {
"type": "string",
"format": "FIXMG",
"description": "Fix",
"maxlength": "1"
},
"kzazu": {
"type": "string",
"format": "KZAZU_D",
"description": "OrdCm",
"maxlength": "1"
},
"brgew": {
"type": "string",
"description": "",
"maxlength": "18"
},
"pstyv": {
"type": "string",
"description": "",
"maxlength": "4"
},
"empst": {
"type": "string",
"description": "",
"maxlength": "25"
},
"abtnr": {
"type": "string",
"description": "",
"maxlength": "4"
},
"abrvw": {
"type": "string",
"description": "",
"maxlength": "3"
},
"werks": {
"type": "string",
"description": "",
"maxlength": "4"
},
"lprio": {
"type": "string",
"description": "",
"maxlength": "2"
},
"lprio_bez": {
"type": "string",
"description": "",
"maxlength": "20"
},
"route": {
"type": "string",
"description": "",
"maxlength": "6"
},
"route_bez": {
"type": "string",
"description": "",
"maxlength": "40"
},
"lgort": {
"type": "string",
"description": "",
"maxlength": "4"
},
"vstel": {
"type": "string",
"description": "",
"maxlength": "4"
},
"delco": {
"type": "string",
"description": "",
"maxlength": "3"
},
"matnr": {
"type": "string",
"description": "",
"maxlength": "35"
},
"valtg": {
"type": "string",
"description": "",
"maxlength": "2"
},
"hipos": {
"type": "string",
"description": "",
"maxlength": "6"
},
"hievw": {
"type": "string",
"description": "",
"maxlength": "1"
},
"posguid": {
"type": "string",
"description": "",
"maxlength": "22"
},
"matnr_external": {
"type": "string",
"description": "",
"maxlength": "40"
},
"matnr_version": {
"type": "string",
"description": "",
"maxlength": "10"
},
"matnr_guid": {
"type": "string",
"description": "",
"maxlength": "32"
},
"iuid_relevant": {
"type": "string",
"description": "",
"maxlength": "1"
},
"sgt_rcat": {
"type": "string",
"description": "",
"maxlength": "16"
},
"sgt_scat": {
"type": "string",
"description": "",
"maxlength": "16"
},
"handoverloc": {
"type": "string",
"description": "",
"maxlength": "10"
},
"matnr_long": {
"type": "string",
"description": "",
"maxlength": "40"
},
"req_seg_long": {
"type": "string",
"description": "",
"maxlength": "40"
},
"stk_seg_long": {
"type": "string",
"description": "",
"maxlength": "40"
},
"expected_value": {
"type": "string",
"description": "",
"maxlength": "31"
},
"limit_amount": {
"type": "string",
"description": "",
"maxlength": "31"
},
"e1edp02": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"qualf": {
"type": "string",
"format": "EDI_QUALFR",
"description": "Qualifier",
"maxlength": "3"
},
"belnr": {
"type": "string",
"format": "EDI_BELNR",
"description": "Document",
"maxlength": "35"
},
"zeile": {
"type": "string",
"format": "EDI1082_A",
"description": "DocItm",
"maxlength": "6"
},
"datum": {
"type": "string",
"format": "EDIDAT8",
"description": "Date",
"maxlength": "8"
},
"uzeit": {
"type": "string",
"format": "EDITIM6",
"description": "Time",
"maxlength": "6"
},
"bsark": {
"type": "string",
"description": "",
"maxlength": "35"
},
"ihrez": {
"type": "string",
"description": "",
"maxlength": "30"
},
"rma": {
"type": "string",
"description": "",
"maxlength": "20"
},
"reason": {
"type": "string",
"description": "",
"maxlength": "3"
},
"rsntxt": {
"type": "string",
"description": "",
"maxlength": "40"
}
}
}
},
"e1edp03": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"iddat": {
"type": "string",
"format": "EDI_IDDAT",
"description": "Qualifier",
"maxlength": "3"
},
"datum": {
"type": "string",
"format": "EDIF2380_D",
"description": "Date",
"maxlength": "8"
},
"uzeit": {
"type": "string",
"format": "EDIF2380_U",
"description": "Time",
"maxlength": "6"
}
}
}
},
"e1edp19": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"qualf": {
"type": "string",
"format": "EDI_QUALFI",
"description": "Identification",
"maxlength": "3"
},
"idtnr": {
"type": "string",
"format": "EDI_IDTNR",
"description": "Material",
"maxlength": "35"
},
"ktext": {
"type": "string",
"format": "EDI_KTEXT",
"description": "Short text",
"maxlength": "70"
},
"mfrpn": {
"type": "string",
"description": "",
"maxlength": "42"
},
"mfrnr": {
"type": "string",
"description": "",
"maxlength": "10"
},
"idtnr_external": {
"type": "string",
"description": "",
"maxlength": "40"
},
"idtnr_version": {
"type": "string",
"description": "",
"maxlength": "10"
},
"idtnr_guid": {
"type": "string",
"description": "",
"maxlength": "32"
},
"idtnr_long": {
"type": "string",
"description": "",
"maxlength": "40"
}
}
}
},
"e1edp26": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"qualf": {
"type": "string",
"format": "QUALIBETRG",
"description": "Qualifier",
"maxlength": "3"
},
"betrg": {
"type": "string",
"format": "EDI_SUMME",
"description": "Overall",
"maxlength": "18"
}
}
}
},
"e1edpa1": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"parvw": {
"type": "string",
"format": "EDI3035_A",
"description": "Role",
"maxlength": "3"
},
"partn": {
"type": "string",
"format": "PARTNER",
"description": "Partner",
"maxlength": "17"
},
"lifnr": {
"type": "string",
"format": "LIFNR_ED1",
"description": "Supplier",
"maxlength": "17"
},
"name1": {
"type": "string",
"format": "EDI3036_A",
"description": "Name 1",
"maxlength": "35"
},
"name2": {
"type": "string",
"format": "EDI3036_B",
"description": "Name 2",
"maxlength": "35"
},
"name3": {
"type": "string",
"format": "EDI3036_C",
"description": "Name 3",
"maxlength": "35"
},
"name4": {
"type": "string",
"format": "EDI3036_D",
"description": "Name 4",
"maxlength": "35"
},
"stras": {
"type": "string",
"format": "EDI3042_A",
"description": "Street and house number 1",
"maxlength": "35"
},
"strs2": {
"type": "string",
"format": "EDI3042_C",
"description": "Street and house number 2",
"maxlength": "35"
},
"pfach": {
"type": "string",
"format": "EDI3042_B",
"description": "PO Box",
"maxlength": "35"
},
"ort01": {
"type": "string",
"format": "EDI3164_A",
"description": "City",
"maxlength": "35"
},
"counc": {
"type": "string",
"format": "EDI3229_A",
"description": "County code",
"maxlength": "9"
},
"pstlz": {
"type": "string",
"format": "EDI3251_A",
"description": "Postal code",
"maxlength": "9"
},
"pstl2": {
"type": "string",
"format": "EDI3251_B",
"description": "PO Box pcd",
"maxlength": "9"
},
"land1": {
"type": "string",
"format": "EDI3207_A",
"description": "Ctry",
"maxlength": "3"
},
"ablad": {
"type": "string",
"format": "EDI3224LA",
"description": "Unloading Point",
"maxlength": "35"
},
"pernr": {
"type": "string",
"format": "EDI3413LB",
"description": "Pers. No.",
"maxlength": "30"
},
"parnr": {
"type": "string",
"format": "EDI3413LC",
"description": "Contact",
"maxlength": "30"
},
"telf1": {
"type": "string",
"format": "EDI3148_A",
"description": "Telephone Number",
"maxlength": "25"
},
"telf2": {
"type": "string",
"format": "EDI3148_B",
"description": "Telephone 2",
"maxlength": "25"
},
"telbx": {
"type": "string",
"format": "EDI3148_C",
"description": "Telebox",
"maxlength": "25"
},
"telfx": {
"type": "string",
"format": "EDI3148_D",
"description": "Fax number",
"maxlength": "25"
},
"teltx": {
"type": "string",
"format": "EDI3148_E",
"description": "Teletex no.",
"maxlength": "25"
},
"telx1": {
"type": "string",
"format": "EDI3148_F",
"description": "Telex number",
"maxlength": "25"
},
"spras": {
"type": "string",
"format": "EDI_SPRAS",
"description": "L",
"maxlength": "1"
},
"anred": {
"type": "string",
"format": "EDI_ANRED",
"description": "Form of address",
"maxlength": "15"
},
"ort02": {
"type": "string",
"format": "EDI_ORT02",
"description": "District",
"maxlength": "35"
},
"hausn": {
"type": "string",
"format": "EDI_HAUSN",
"description": "House#",
"maxlength": "6"
},
"stock": {
"type": "string",
"format": "EDI_STOCK",
"description": "Floor",
"maxlength": "6"
},
"regio": {
"type": "string",
"format": "EDI_REGIO",
"description": "Reg",
"maxlength": "3"
},
"parge": {
"type": "string",
"format": "EDI_PARGE",
"description": "G",
"maxlength": "1"
},
"isoal": {
"type": "string",
"format": "INTCA",
"description": "ISO code",
"maxlength": "2"
},
"isonu": {
"type": "string",
"format": "INTCA",
"description": "ISO code",
"maxlength": "2"
},
"fcode": {
"type": "string",
"format": "EDI_FCODE",
"description": "Company key - France",
"maxlength": "20"
},
"ihrez": {
"type": "string",
"format": "EDI3413LA",
"description": "Your reference",
"maxlength": "30"
},
"bname": {
"type": "string",
"format": "EDI_BNAME",
"description": "User Name",
"maxlength": "35"
},
"paorg": {
"type": "string",
"format": "EDI_PAORG",
"description": "Org.code",
"maxlength": "30"
},
"orgtx": {
"type": "string",
"format": "EDI_ORGTX",
"description": "Text",
"maxlength": "35"
},
"pagru": {
"type": "string",
"format": "EDI_PAGRU",
"description": "Group code",
"maxlength": "30"
},
"knref": {
"type": "string",
"format": "KNREF",
"description": "Part",
"maxlength": "30"
},
"ilnnr": {
"type": "string",
"format": "CHAR70",
"description": "Char 70",
"maxlength": "70"
},
"pfort": {
"type": "string",
"description": "",
"maxlength": "35"
},
"spras_iso": {
"type": "string",
"description": "",
"maxlength": "2"
},
"title": {
"type": "string",
"description": "",
"maxlength": "15"
}
}
}
},
"e1edp05": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"alckz": {
"type": "string",
"format": "EDI5463_A",
"description": "Sign",
"maxlength": "3"
},
"kschl": {
"type": "string",
"format": "EDI5189_A",
"description": "Condition type",
"maxlength": "4"
},
"kotxt": {
"type": "string",
"format": "EDI1230LA",
"description": "Condition text",
"maxlength": "80"
},
"betrg": {
"type": "string",
"format": "EDI5004_P",
"description": "Fixed sur./disc.",
"maxlength": "18"
},
"kperc": {
"type": "string",
"format": "EDI5482_C",
"description": "Percent",
"maxlength": "8"
},
"krate": {
"type": "string",
"format": "EDI5420_A",
"description": "Condition record",
"maxlength": "15"
},
"uprbs": {
"type": "string",
"format": "EDI5284_A",
"description": "per",
"maxlength": "9"
},
"meaun": {
"type": "string",
"format": "EDI6411_F",
"description": "Unit of measurement",
"maxlength": "3"
},
"kobtr": {
"type": "string",
"format": "EDI_KOBTR",
"description": "Amount",
"maxlength": "18"
},
"menge": {
"type": "string",
"format": "SPEC_MENGE",
"description": "Quantity",
"maxlength": "15"
},
"preis": {
"type": "string",
"format": "SPEC_PREIS",
"description": "Price",
"maxlength": "15"
},
"mwskz": {
"type": "string",
"format": "EDI5279_A",
"description": "VAT indicator",
"maxlength": "7"
},
"msatz": {
"type": "string",
"format": "EDI5278_A",
"description": "VAT rate",
"maxlength": "17"
},
"koein": {
"type": "string",
"description": "",
"maxlength": "3"
},
"curtp": {
"type": "string",
"description": "",
"maxlength": "2"
},
"kobas": {
"type": "string",
"description": "",
"maxlength": "18"
}
}
}
},
"e1edp04": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"mwskz": {
"type": "string",
"format": "EDI5279_A",
"description": "VAT indicator",
"maxlength": "7"
},
"msatz": {
"type": "string",
"format": "EDI5278_A",
"description": "VAT rate",
"maxlength": "17"
},
"mwsbt": {
"type": "string",
"format": "EDI5004_O",
"description": "VAT amount",
"maxlength": "18"
},
"txjcd": {
"type": "string",
"format": "TXJCD",
"description": "Tax Jur.",
"maxlength": "15"
},
"ktext": {
"type": "string",
"description": "",
"maxlength": "50"
},
"txdat": {
"type": "string",
"description": "",
"maxlength": "8"
}
}
}
},
"e1edp28": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"exnum": {
"type": "string",
"description": "",
"maxlength": "10"
},
"expos": {
"type": "string",
"description": "",
"maxlength": "6"
},
"stawn": {
"type": "string",
"description": "",
"maxlength": "17"
},
"exprf": {
"type": "string",
"description": "",
"maxlength": "5"
},
"exart": {
"type": "string",
"description": "",
"maxlength": "2"
},
"herkl": {
"type": "string",
"description": "",
"maxlength": "3"
},
"herkr": {
"type": "string",
"description": "",
"maxlength": "3"
},
"herta": {
"type": "string",
"description": "",
"maxlength": "3"
},
"herti": {
"type": "string",
"description": "",
"maxlength": "15"
},
"stxt1": {
"type": "string",
"description": "",
"maxlength": "40"
},
"stxt2": {
"type": "string",
"description": "",
"maxlength": "40"
},
"stxt3": {
"type": "string",
"description": "",
"maxlength": "40"
},
"stxt4": {
"type": "string",
"description": "",
"maxlength": "40"
},
"stxt5": {
"type": "string",
"description": "",
"maxlength": "40"
},
"stxt6": {
"type": "string",
"description": "",
"maxlength": "40"
},
"stxt7": {
"type": "string",
"description": "",
"maxlength": "40"
},
"bemas": {
"type": "string",
"description": "",
"maxlength": "5"
},
"prefe": {
"type": "string",
"description": "",
"maxlength": "1"
},
"bolnr": {
"type": "string",
"description": "",
"maxlength": "35"
},
"traty": {
"type": "string",
"description": "",
"maxlength": "4"
},
"traid": {
"type": "string",
"description": "",
"maxlength": "20"
},
"brulo": {
"type": "string",
"description": "",
"maxlength": "18"
},
"netlo": {
"type": "string",
"description": "",
"maxlength": "18"
},
"vemeh": {
"type": "string",
"description": "",
"maxlength": "3"
},
"herbl": {
"type": "string",
"description": "",
"maxlength": "2"
},
"bmgew": {
"type": "string",
"description": "",
"maxlength": "18"
},
"text1": {
"type": "string",
"description": "",
"maxlength": "40"
},
"text2": {
"type": "string",
"description": "",
"maxlength": "40"
},
"text3": {
"type": "string",
"description": "",
"maxlength": "40"
},
"coimp": {
"type": "string",
"description": "",
"maxlength": "17"
},
"coadi": {
"type": "string",
"description": "",
"maxlength": "6"
},
"cokon": {
"type": "string",
"description": "",
"maxlength": "6"
},
"copha": {
"type": "string",
"description": "",
"maxlength": "6"
},
"casnr": {
"type": "string",
"description": "",
"maxlength": "15"
},
"verld": {
"type": "string",
"description": "",
"maxlength": "3"
},
"verld_tx": {
"type": "string",
"description": "",
"maxlength": "15"
},
"hanld": {
"type": "string",
"description": "",
"maxlength": "3"
},
"hanld_tx": {
"type": "string",
"description": "",
"maxlength": "15"
},
"exprf_tx": {
"type": "string",
"description": "",
"maxlength": "30"
},
"exart_tx": {
"type": "string",
"description": "",
"maxlength": "30"
},
"gbnum": {
"type": "string",
"description": "",
"maxlength": "20"
},
"regnr": {
"type": "string",
"description": "",
"maxlength": "20"
},
"herse": {
"type": "string",
"description": "",
"maxlength": "10"
},
"herkr_tx": {
"type": "string",
"description": "",
"maxlength": "20"
},
"cobld": {
"type": "string",
"description": "",
"maxlength": "17"
},
"eioka": {
"type": "string",
"description": "",
"maxlength": "1"
},
"verfa": {
"type": "string",
"description": "",
"maxlength": "8"
},
"prenc": {
"type": "string",
"description": "",
"maxlength": "1"
},
"preno": {
"type": "string",
"description": "",
"maxlength": "8"
},
"prend": {
"type": "string",
"description": "",
"maxlength": "8"
},
"besma": {
"type": "string",
"description": "",
"maxlength": "3"
},
"impma": {
"type": "string",
"description": "",
"maxlength": "3"
},
"ktnum": {
"type": "string",
"description": "",
"maxlength": "10"
},
"plnum": {
"type": "string",
"description": "",
"maxlength": "10"
},
"wkreg": {
"type": "string",
"description": "",
"maxlength": "3"
},
"imgew": {
"type": "string",
"description": "",
"maxlength": "18"
}
}
}
},
"e1edp08": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"hlnum": {
"type": "string",
"format": "EDI7164_A",
"description": "HierarchyNo.",
"maxlength": "12"
},
"parent": {
"type": "string",
"format": "EDI7166_A",
"description": " Parent ID",
"maxlength": "12"
},
"level": {
"type": "string",
"format": "EDI7164_B",
"description": "Level",
"maxlength": "12"
},
"exidv": {
"type": "string",
"format": "EDI7064_A",
"description": "Ext.ship.unit ID",
"maxlength": "45"
},
"venum": {
"type": "string",
"format": "VENUM",
"description": "Int. HU no",
"maxlength": "10"
},
"vemeh": {
"type": "string",
"format": "CHAR3",
"description": "",
"maxlength": "3"
},
"pckar": {
"type": "string",
"format": "PCKAR",
"description": "Packing type",
"maxlength": "35"
},
"pcknr": {
"type": "string",
"format": "PCKNR",
"description": "Cust.shipping un.no.",
"maxlength": "35"
},
"anzar": {
"type": "string",
"format": "EDI_ANZAR",
"description": "Max.number",
"maxlength": "15"
},
"vbeln": {
"type": "string",
"format": "EDI1004_LF",
"description": "Delivery",
"maxlength": "35"
},
"posnr": {
"type": "string",
"format": "EDI1156_D",
"description": "Delivery item",
"maxlength": "30"
},
"btgew": {
"type": "string",
"format": "EDI6314_B",
"description": "Total weight",
"maxlength": "18"
},
"ntgew": {
"type": "string",
"format": "EDI6314_A",
"description": "Net weight",
"maxlength": "18"
},
"tarag": {
"type": "string",
"format": "EDI6314_D",
"description": "Tare weight",
"maxlength": "18"
},
"gewei": {
"type": "string",
"format": "EDI6411_D",
"description": "WUn",
"maxlength": "3"
},
"btvol": {
"type": "string",
"format": "EDI6314_E",
"description": "Total volume",
"maxlength": "18"
},
"ntvol": {
"type": "string",
"format": "EDI6314_F",
"description": "Loading volume",
"maxlength": "18"
},
"tavol": {
"type": "string",
"format": "EDI6314_G",
"description": "Tare volume",
"maxlength": "18"
},
"voleh": {
"type": "string",
"format": "EDI6411_G",
"description": "VUn",
"maxlength": "3"
},
"laeng": {
"type": "string",
"format": "EDI6314_H",
"description": "Length",
"maxlength": "18"
},
"breit": {
"type": "string",
"format": "EDI6314_I",
"description": "Width",
"maxlength": "18"
},
"hoehe": {
"type": "string",
"format": "EDI6314_J",
"description": "Height",
"maxlength": "18"
},
"meabm": {
"type": "string",
"format": "EDI6411_H",
"description": "UoD",
"maxlength": "3"
},
"meins": {
"type": "string",
"format": "EDI6411_I",
"description": "UoM",
"maxlength": "3"
},
"vstel": {
"type": "string",
"format": "EDI3224_L",
"description": "Shipping point",
"maxlength": "17"
},
"lstel": {
"type": "string",
"format": "EDI3224_M",
"description": "Loading point",
"maxlength": "17"
},
"pknrs": {
"type": "string",
"format": "EDI_PKNRS",
"description": "Shipment no.key",
"maxlength": "1"
}
}
}
},
"e1edpt1": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"tdid": {
"type": "string",
"format": "EDI4451_A",
"description": "ID",
"maxlength": "4"
},
"tsspras": {
"type": "string",
"format": "EDI3453_A",
"description": "LG",
"maxlength": "3"
},
"tsspras_iso": {
"type": "string",
"description": "",
"maxlength": "2"
},
"e1edpt2": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"tdline": {
"type": "string",
"format": "EDI4040_A",
"description": "Text line",
"maxlength": "70"
},
"tdformat": {
"type": "string",
"description": "",
"maxlength": "2"
}
}
}
}
}
}
}
}
}
},
"e1eds01": {
"type": "array",
"description": "",
"items": {
"type": "object",
"description": "",
"properties": {
"sumid": {
"type": "string",
"format": "SUMID",
"description": "Qualifier",
"maxlength": "3"
},
"summe": {
"type": "string",
"format": "EDI_SUMME",
"description": "Overall",
"maxlength": "18"
},
"sunit": {
"type": "string",
"format": "SUNIT",
"description": "Unit",
"maxlength": "3"
},
"waerq": {
"type": "string",
"format": "EDI6345_A",
"description": "Curr.",
"maxlength": "3"
}
}
}
}
}
}
}
}
}
Health Check
Request to verify that the system of record is online
Health Check - SOR
GET
https://baseline.provide.services/api/v1/organizations/:id/proxy
Checks the health of the system of record
Path Parameters
id
string
id
of organization related to the middleware
Proxy Health Check
Request to verify that the system of record can communicate with the proxy
Health Check - Middleware
GET
https://baseline.provide.services/api/v1/status
Verifies that a system of record can communicate with the middleware
Updating an Object
When updating an object, the baseline_id
must be relayed with each request. The functions the middleware integration support are as follows:
Update Object
PUT
https://baseline.provide.services/api/v1/objects/:id
Updates a specified Object
Path Parameters
id*
string
id
of object to be updated
Request Body
baseline_id
string
globally-unique UUID used to map the record to the BaselineContext
object
object
arbitrary data that holds the ProtocolMessagePayload
proof
string
cryptographic proof
from a Prover
type
string
type of Prover
being used; currently this should be set to general_consistency
witness
string
public and private inputs used to generate the Proof
. Payload can be delivered as a JSON object or chunked and streamed
Updating an Object Status
Update Object Status
PUT
https://baseline.provide.services/api/v1/business_objects/:id/status
Updates the status of a specified Object
Path Parameters
id
string
id of Object
to be updated
Last updated