API Reference

The example requests on the current page can be displayed either in JSON or XML. CLick a resource to view details.

EXPAND ALL

HTTP Method Resource Produces Consumes HTTP Status

PUT external/account/branches/new text/xml application/json 204

Resource details.

Description Creates a company account as the child of the current account using the provided data in the body of the PUT call

Input

//Class: com.tradeshift.users.rest.CreateCompanyAccountRequest
{
  "CompanyAccount" : {
    "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// Company accounts are either ACTIVE or LOCKED
    "State" : "CREATED",
// Company details for this company account
    "Company" : {
      "CompanyName" : null,
      "Country" : null,
      "Created" : null,
      "Modified" : null,
      "Identifier" : null,
      "AddressLine" : null,
      "Phone" : null,
      "Fax" : null,
      "LegalCompanyStructure" : null,
// If the profile is restricted, and address lines have been stripped off, this will be true. If not restricted, it will be null.
      "AddressAvailable" : null,
      "RegistrationAddress" : null
    },
    "Url" : "str",
    "Description" : "str",
// Shorturl for the company. Must be unique, and is only used on real company accounts.
    "ShortUrl" : "str",
    "PublicProfile" : "false",
    "NonuserInvoicing" : "false",
    "AutoAcceptConnections" : "false",
// True if only non-sensitive fields are revealed when others retrieve the account
    "Restricted" : "false",
// A list of account properties. This is normally not set when retrieving an account.
    "Property" : null,
    "Offering" : null,
    "LookingFor" : null,
    "Industry" : "ACADEMIA",
    "OtherIndustry" : "str",
    "OwnershipType" : "SOLE",
    "Size" : "ONE",
    "NumConnections" : "0",
    "PrimaryBankAccount" : {
      "channelCode" : "str",
      "branchId" : "str",
      "paymentNote" : "str",
      "institutionId" : "str",
      "institutionName" : "str",
      "branchName" : "str",
      "value" : "str",
      "beneficiaryName" : "str",
      "beneficiaryBankStreetName" : "str",
      "beneficiaryBankAdditionalStreetName" : "str",
      "beneficiaryBankBuildingNumber" : "str",
      "beneficiaryBankCityName" : "str",
      "beneficiaryBankPostalZone" : "str",
      "beneficiaryBankCountrySubentity" : "str",
      "beneficiaryBankAddress" : "str",
      "beneficiaryBankCountryCode" : "str",
      "accountTypeCode" : "str"
    },
    "AccountType" : "FREE",
    "RegisteredGLI" : [  ]
  },
  "User" : {
    "Id" : null,
    "Person" : null,
    "CompanyAccountId" : null,
    "UserName" : null,
    "Credentials" : null,
    "State" : null,
    "ReturnUrl" : null,
    "Language" : "en_US",
    "Kind" : "PERSON",
    "LastLogin" : null,
    "TimeZone" : null,
    "Visible" : "true",
    "OverridingCompanyAccountId" : null,
    "CompanyAccountIdModifyDate" : null
  },
  "From" : "str",
  "Activate" : "false",
  "SendActivationEmail" : "false",
  "Properties" : {
    "str" : "str"
  },
  "CompanyProperties" : {
    "str" : "str"
  },
  "ParentCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Images" : [  ],
  "InvitedBy" : "str"
}

GET external/account/branches/{id} text/xml application/json 200404

Resource details.
Description	Get specific branch for the current parent
Returns	404 If the specific branch isn't found or isn't a branch of the current parent.
Output	//Class: com.tradeshift.users.dto.CompanyAccountDTO { "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46", // Company accounts are either ACTIVE or LOCKED "State" : "CREATED", // Company details for this company account "Company" : { "CompanyName" : null, "Country" : null, "Created" : null, "Modified" : null, "Identifier" : null, "AddressLine" : null, "Phone" : null, "Fax" : null, "LegalCompanyStructure" : null, // If the profile is restricted, and address lines have been stripped off, this will be true. If not restricted, it will be null. "AddressAvailable" : null, "RegistrationAddress" : null }, "Url" : "str", "Description" : "str", // Shorturl for the company. Must be unique, and is only used on real company accounts. "ShortUrl" : "str", "PublicProfile" : "false", "NonuserInvoicing" : "false", "AutoAcceptConnections" : "false", // True if only non-sensitive fields are revealed when others retrieve the account "Restricted" : "false", // A list of account properties. This is normally not set when retrieving an account. "Property" : null, "Offering" : null, "LookingFor" : null, "Industry" : "ACADEMIA", "OtherIndustry" : "str", "OwnershipType" : "SOLE", "Size" : "ONE", "NumConnections" : "0", "PrimaryBankAccount" : { "channelCode" : "str", "branchId" : "str", "paymentNote" : "str", "institutionId" : "str", "institutionName" : "str", "branchName" : "str", "value" : "str", "beneficiaryName" : "str", "beneficiaryBankStreetName" : "str", "beneficiaryBankAdditionalStreetName" : "str", "beneficiaryBankBuildingNumber" : "str", "beneficiaryBankCityName" : "str", "beneficiaryBankPostalZone" : "str", "beneficiaryBankCountrySubentity" : "str", "beneficiaryBankAddress" : "str", "beneficiaryBankCountryCode" : "str", "accountTypeCode" : "str" }, "AccountType" : "FREE", "RegisteredGLI" : [ ] }

GET external/account/branches text/xml application/json

Resource details.

Description Get listing of branches for the current company account, if any

Output

//Class: com.tradeshift.rest.external.CompanyAccountList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "CompanyAccount" : [  ]
}

POST external/account/customers/manual?companyName={companyName}&email={email}&country={country}&skipRequest={skipRequest}

Resource details.

Description Creates an external connection with the provided company name, email and country, and adds that connection as part of the customer list to the public list of customers of the company account that is currently being accessed

Output

//Class: com.tradeshift.customers.CustomerInfo
{
  "CompanyAccountInfo" : {
    "CompanyName" : "str",
    "Country" : "str",
    "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The account state of this company
    "State" : "CREATED",
    "Url" : "str",
    "Description" : "str",
    "Identifiers" : [  ],
    "AddressLines" : [  ],
    "RegistrationAddressLines" : [  ],
    "RegistrationIdentifier" : {
// Company identifier scheme, e.g. DK:CVR, UK:VAT etc. See /external/info/companytypes for a full list.
      "scheme" : "str",
// Value for the company identifier
      "value" : "str"
    },
    "RegistrationCountry" : "str",
// If filled, the limited list of document profiles that the connection will accept.
    "AcceptingDocumentProfiles" : [  ],
    "Properties" : [  ],
    "LookingFor" : null,
    "Offering" : null,
    "LogoURL" : "str",
    "BackgroundURL" : "str",
    "PublicProfile" : "false",
    "NonuserInvoicing" : "false",
    "AutoAcceptConnections" : "false",
// True if only non-sensitive fields are revealed when others retrieve the account
    "Restricted" : "false",
    "NumConnections" : "0",
    "Industry" : "ACADEMIA",
    "OtherIndustry" : "str",
    "OwnershipType" : "SOLE",
    "Size" : "ONE",
    "Created" : "2013-07-23T07:35:16.000Z",
    "Modified" : "2013-07-23T07:35:16.000Z",
    "Phone" : "str",
    "Fax" : "str",
    "ShortUrl" : "str",
    "AccountType" : "FREE"
  },
  "PublicCustomer" : "false",
  "ExternalCustomer" : "false"
}

PUT external/account/customers/{customerCompanyId}

Resource details.
Description	Adds the company specified by the customerCompanyId path parameter to the public list of customers of the company account that is currently being accessed

DELETE external/account/customers/{customerCompanyId} 204404

Resource details.
Description	Removes the company specified the customerCompanyId from the public customers list of the company account that is currently being accessed The removed company will still show up in the customers list, however will not be marked as public

GET external/account/customers?onlyPublic={onlyPublic}&limit={limit}&page={page}

Resource details.
Description	Returns a list of CompanyAccountInfos for the companies who are customers of the company account that is currently being accessed
Output	`//Class: com.tradeshift.customers.CustomerList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Customers" : [ ] }`

GET external/account/info/user text/xml application/json 200

Resource details.
Description	Returns information about the user account currently accessing the system. Be aware that under normal circumstances, this will be a special app user, not the user who has installed an app.

GET external/account/info text/xml application/json 200

Resource details.

Description Returns information about the company account that is currently being accessed.

Output

//Class: com.tradeshift.rest.external.CompanyAccountInfo
{
  "CompanyName" : "str",
  "Country" : "str",
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The account state of this company
  "State" : "CREATED",
  "Url" : "str",
  "Description" : "str",
  "Identifiers" : [  ],
  "AddressLines" : [  ],
  "RegistrationAddressLines" : [  ],
  "RegistrationIdentifier" : {
// Company identifier scheme, e.g. DK:CVR, UK:VAT etc. See /external/info/companytypes for a full list.
    "scheme" : "str",
// Value for the company identifier
    "value" : "str"
  },
  "RegistrationCountry" : "str",
// If filled, the limited list of document profiles that the connection will accept.
  "AcceptingDocumentProfiles" : [  ],
  "Properties" : [  ],
  "LookingFor" : null,
  "Offering" : null,
  "LogoURL" : "str",
  "BackgroundURL" : "str",
  "PublicProfile" : "false",
  "NonuserInvoicing" : "false",
  "AutoAcceptConnections" : "false",
// True if only non-sensitive fields are revealed when others retrieve the account
  "Restricted" : "false",
  "NumConnections" : "0",
  "Industry" : "ACADEMIA",
  "OtherIndustry" : "str",
  "OwnershipType" : "SOLE",
  "Size" : "ONE",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Modified" : "2013-07-23T07:35:16.000Z",
  "Phone" : "str",
  "Fax" : "str",
  "ShortUrl" : "str",
  "AccountType" : "FREE"
}

PUT external/account/info 204

Resource details.

Description Update company information for the current company account. Properties will not be changed using this resource.

Input

//Class: com.tradeshift.rest.external.CompanyAccountInfo
{
  "CompanyName" : "str",
  "Country" : "str",
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The account state of this company
  "State" : "CREATED",
  "Url" : "str",
  "Description" : "str",
  "Identifiers" : [  ],
  "AddressLines" : [  ],
  "RegistrationAddressLines" : [  ],
  "RegistrationIdentifier" : {
// Company identifier scheme, e.g. DK:CVR, UK:VAT etc. See /external/info/companytypes for a full list.
    "scheme" : "str",
// Value for the company identifier
    "value" : "str"
  },
  "RegistrationCountry" : "str",
// If filled, the limited list of document profiles that the connection will accept.
  "AcceptingDocumentProfiles" : [  ],
  "Properties" : [  ],
  "LookingFor" : null,
  "Offering" : null,
  "LogoURL" : "str",
  "BackgroundURL" : "str",
  "PublicProfile" : "false",
  "NonuserInvoicing" : "false",
  "AutoAcceptConnections" : "false",
// True if only non-sensitive fields are revealed when others retrieve the account
  "Restricted" : "false",
  "NumConnections" : "0",
  "Industry" : "ACADEMIA",
  "OtherIndustry" : "str",
  "OwnershipType" : "SOLE",
  "Size" : "ONE",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Modified" : "2013-07-23T07:35:16.000Z",
  "Phone" : "str",
  "Fax" : "str",
  "ShortUrl" : "str",
  "AccountType" : "FREE"
}

DELETE external/account/members/{userId}

Resource details.
Description	Remove a member from the current company account. Users who belong to the account (have the account's CompanyAccountId) cannot be removed.

GET external/account/parent text/xml application/json 200404

Resource details.
Description	Returns information about the parent account of the current account (the parent is the account of which the current account is a branch)
Returns	404 if current account doesn't have a parent account
Output	//Class: com.tradeshift.rest.external.CompanyAccountInfo { "CompanyName" : "str", "Country" : "str", "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46", // The account state of this company "State" : "CREATED", "Url" : "str", "Description" : "str", "Identifiers" : [ ], "AddressLines" : [ ], "RegistrationAddressLines" : [ ], "RegistrationIdentifier" : { // Company identifier scheme, e.g. DK:CVR, UK:VAT etc. See /external/info/companytypes for a full list. "scheme" : "str", // Value for the company identifier "value" : "str" }, "RegistrationCountry" : "str", // If filled, the limited list of document profiles that the connection will accept. "AcceptingDocumentProfiles" : [ ], "Properties" : [ ], "LookingFor" : null, "Offering" : null, "LogoURL" : "str", "BackgroundURL" : "str", "PublicProfile" : "false", "NonuserInvoicing" : "false", "AutoAcceptConnections" : "false", // True if only non-sensitive fields are revealed when others retrieve the account "Restricted" : "false", "NumConnections" : "0", "Industry" : "ACADEMIA", "OtherIndustry" : "str", "OwnershipType" : "SOLE", "Size" : "ONE", "Created" : "2013-07-23T07:35:16.000Z", "Modified" : "2013-07-23T07:35:16.000Z", "Phone" : "str", "Fax" : "str", "ShortUrl" : "str", "AccountType" : "FREE" }

GET external/account/public/users?q={q}&page={page}&limit={limit}

Resource details.
Description	Searches visible users in all companies (not only the current account) for the query string
Parameters	q - User to search for page - the page to be retrieved limit - the number of items in a page
Output	`//Class: com.tradeshift.rest.external.UserList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "UserAccounts" : null, "PrimaryUser" : "58a5b768-08be-48ec-a06d-6874fde8cf46" }`

PUT external/account/taxes

Resource details.
Description	Update tax categories.
Input	`//Class: com.tradeshift.rest.external.ExternalCompanyTaxes { "StackedTaxes" : [ ], "DefaultTaxIndex" : "0" }`

GET external/account/taxes?connectionID={connectionID}

Resource details.
Description	Get tax categories. Lists the company taxes for the requesting context, if connectionID is specified it will also include the default tax from the connectionproperties
Output	`//Class: com.tradeshift.rest.external.ExternalCompanyTaxes { "StackedTaxes" : [ ], "DefaultTaxIndex" : "0" }`

GET external/account/users/byemail/{email}?searchparent={searchparent}&searchlocked={searchlocked} text/xml application/json

Resource details.
Description	Find if a user exists inside a company. Case insensitive
Returns	The user description
Output	`//Class: com.tradeshift.users.dto.UserDTO { "Id" : null, "Person" : null, "CompanyAccountId" : null, "UserName" : null, "Credentials" : null, "State" : null, "ReturnUrl" : null, "Language" : "en_US", "Kind" : "PERSON", "LastLogin" : null, "TimeZone" : null, "Visible" : "true", "OverridingCompanyAccountId" : null, "CompanyAccountIdModifyDate" : null }`

PUT external/account/users/{userId}/role 204403

Resource details.
Description	Create or update user role

PUT external/account/users/{userId}/state text/plain 204403

Resource details.
Description	Set the state of a user.

GET external/account/users/{userId} 200404

Resource details.

Output

//Class: com.tradeshift.rest.external.UserAccountInfo
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root account for this user
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root company name for this user
  "CompanyName" : "str",
  "Username" : "str",
  "Language" : "str",
  "TimeZone" : "str",
  "Memberships" : null,
// When the user was created
  "Created" : "2013-07-23T07:35:16.000Z",
  "State" : "CREATED",
  "Type" : "PERSON",
  "FirstName" : "str",
  "LastName" : "str",
  "Title" : "str",
  "PictureUrl" : "str",
  "Visible" : "false"
}

PUT external/account/users/{userId}?sendActivationMail={sendActivationMail}

Resource details.

Description Create or update a user inside the current company account

Input

//Class: com.tradeshift.rest.external.UserAccountInfoUpdateRole
// Superclass: com.tradeshift.rest.external.UserAccountInfoUpdate
// Superclass: com.tradeshift.rest.external.UserAccountInfo
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root account for this user
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root company name for this user
  "CompanyName" : "str",
  "Username" : "str",
  "Language" : "str",
  "TimeZone" : "str",
  "Memberships" : null,
// When the user was created
  "Created" : "2013-07-23T07:35:16.000Z",
  "State" : "CREATED",
  "Type" : "PERSON",
  "FirstName" : "str",
  "LastName" : "str",
  "Title" : "str",
  "PictureUrl" : "str",
  "Visible" : "false"
  "Password" : "str"
  "RoleId" : "58a5b768-08be-48ec-a06d-6874fde8cf46"
}

GET external/account/users?page={page}&limit={limit}&visible={visible} 200400

Resource details.

Description Get a list of users associated with the current account

Output

//Class: com.tradeshift.rest.external.UserList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "UserAccounts" : null,
  "PrimaryUser" : "58a5b768-08be-48ec-a06d-6874fde8cf46"
}

GET external/account/validations/activeapp text/xml application/json

Resource details.

DELETE external/account/validations/all 204

Resource details.
Description	Deletes all dynamic validation for this account. *** Only available when the relevant features have been enabled for the account.

POST external/account/validations/changes?file={file} text/xml application/json 204403

Resource details.
Description	Processes a set of changes to a validation. If any errors are encountered in the set of changes, no changes will be applied. For each changed value, only Value and (optionally) Sender need to be set. *** Only available when the relevant features have been enabled for the account.
Returns	403 If the feature is not available for this account.

GET external/account/validations/errors/{dynamicvalidationid}/details?eventid={eventid} text/xml application/json 200404

Resource details.

GET external/account/validations/errors?field={field}&after={after}&before={before}&page={page}&limit={limit} text/xml application/json 200404

Resource details.

Output

//Class: com.tradeshift.rest.external.DynamicValidationEventList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "DynamicValidationEvents" : null
}

GET external/account/validations/historydata/{historicid} text/xml application/json 200404

Resource details.

Description get dynamic validation changes file populated with content

Output

//Class: com.tradeshift.rest.external.DynamicValidationValueHistoryElement
{
  "changes" : "[B@6b43c86",
  "created" : "0",
  "filename" : "str",
  "filesize" : "0",
  "id" : "58a5b768-08be-48ec-a06d-6874fde8cf46"
}

GET external/account/validations/list?limit={limit}&page={page} text/xml application/json 200403

Resource details.
Description	Returns all dynamic validations that have been created for the account. *** Only available when the relevant features have been enabled for the account.
Returns	403 If the feature is not available for this account.
Output	`//Class: com.tradeshift.rest.external.DynamicValidationList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "DynamicValidation" : null }`

GET external/account/validations/log?after={after}&before={before}&page={page}&limit={limit} text/xml application/json 200404

Resource details.

Output

//Class: com.tradeshift.rest.external.DynamicValidationEventList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "DynamicValidationEvents" : null
}

GET external/account/validations/usedvalues?validationid={validationid}&valuesetid={valuesetid}&after={after}&before={before} text/xml application/json 200404

Resource details.

Output

//Class: com.tradeshift.rest.external.DynamicValidationEventList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "DynamicValidationEvents" : null
}

GET external/account/validations/values?validationid={validationid}&page={page}&limit={limit}&fieldid={fieldid}&search={search}&matchingvaluesonly={matchingvaluesonly} text/xml application/json 200404

Resource details.

Description List values currently registered for a given dynamicvalidation, by the id of the dynamic validation

Output

//Class: com.tradeshift.rest.external.DynamicValidationValueList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "DynamicValidationValues" : null
}

GET external/account/validations/valuesets?page={page}&limit={limit}&search={search} text/xml application/json 200404

Resource details.

Description List all value sets without retrieving actual values

Output

//Class: com.tradeshift.rest.external.DynamicValidationValueList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "DynamicValidationValues" : null
}

GET external/account/validations/{dynamicvalidationinternalid}/values?page={page}&limit={limit}&search={search} text/xml application/json 200404

Resource details.

Description List all values currently registered for a given dynamicvalidation

Output

//Class: com.tradeshift.rest.external.DynamicValidationValueList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "DynamicValidationValues" : null
}

GET external/account/validations/{dynamicvalidationinternalid}/valueset/{valuesetid}?page={page}&limit={limit} text/xml application/json 200404

Resource details.

Description Get a value set, including values, currently registered for a given dynamicvalidation

Output

//Class: com.tradeshift.rest.external.DynamicValidationValueSet
{
  "Value" : null,
// The sender for which this set validation values are permissable. Both scheme and values must be set. If not given, this value is permissable for all senders.
  "SenderId" : {
    "scheme" : "str",
    "ublvalue" : "str",
    "value" : "str"
    "property" : "false"
  },
  "id" : "str",
  "Created" : "2013-07-23T07:35:16.000Z",
  "AdmittedDocuments" : null,
  "validationId" : "58a5b768-08be-48ec-a06d-6874fde8cf46"
}

GET external/account/validations/{dynamicvalidationinternalid}/valuesets?page={page}&limit={limit}&search={search} text/xml application/json 200404

Resource details.

Description List all value sets currently registered for a given dynamicvalidation without retrieving actual values

Output

//Class: com.tradeshift.rest.external.DynamicValidationValueList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "DynamicValidationValues" : null
}

GET external/account/validations/{externaldynamicvalidationid}/history?after={after}&before={before}&page={page}&limit={limit} text/xml application/json 200404

Resource details.

Description List all files updating a given dynamicvalidation

Output

//Class: com.tradeshift.rest.external.DynamicValidationValueHistoryList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "DynamicValidationValuesHistoryElements" : null
}

GET external/account/validations?id={id} text/xml application/json 200403

Resource details.
Description	Returns a single dynamic validation, by External (enterprise) ID. *** Only available when the relevant features have been enabled for the account.
Returns	403 If the feature is not available for this account.
Output	`//Class: com.tradeshift.rest.external.DynamicValidationList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "DynamicValidation" : null }`

DELETE external/account/validations?id={id} 204403

Resource details.
Description	Deletes a dynamic validation, by External (enterprise) ID. *** Only available when the relevant features have been enabled for the account.
Returns	403 If the feature is not available for this account.

PUT external/account/validations?id={id} text/xml application/json 204403

Resource details.
Description	Saves a single dynamic validation, by external (enterprise) ID of the validation. Only the CompanyAccountId and Field must be set, as the Id is already set in the path of the request. *** Only available when the relevant features have been enabled for the account.
Returns	403 If the feature is not available for this account.
Input	//Class: com.tradeshift.validation.dynamic.DynamicValidation { "version" : "V2", // ID of this validation. "InternalId" : "58a5b768-08be-48ec-a06d-6874fde8cf46", // An ID in external (customer's systems) systems "Id" : "str", // Company identifer of the company account that is the receiver for which this validation is applied. "ReceiverId" : { "scheme" : "str", "ublvalue" : "str", "value" : "str" "property" : "false" }, // ID of the user that created or modified this validation. "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46", // XPath expression into the source UBL document, that is used to get a text value, that must match this validation's values. The supported namespace prefixes in the expression are fixed: inv urn:oasis:names:specification:ubl:schema:xsd:Invoice-2 cac urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2 cbc urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2 ccts urn:oasis:names:specification:ubl:schema:xsd:CoreComponentParameters-2 sdt urn:oasis:names:specification:ubl:schema:xsd:SpecializedDatatypes-2 udt urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2 "Field" : "str", "Evaluate" : { "Evaluate" : null, "type" : "AND", "Field" : null }, // Tune the semantics of this dynamic validation rule. If set to true, the validation will consider a candidate field to be valid if there are no values for this rule for which the sender specification matches the candidate document. If set to false, the behaviour is opposite, and the candidate will be rejected "AllowIfNoSenderValueMatches" : "false", // The document type to which the validation applies, e.g. invoice, order, quote, creditnote. Defaults to invoice. * means all documents, or separate by commas. "DocumentType" : "str", "Created" : "2013-07-23T07:35:16.000Z", "Modified" : "2013-07-23T07:35:16.000Z", "ErrorMessage" : { "DefaultLanguage" : "str", "Label" : null } }

GET external/account/van/activeapp text/xml application/json

Resource details.

GET external/account/van

Resource details.
Description	Get the list of VAN (Value-added-network) accounts for this company account
Output	`//Class: com.tradeshift.rest.external.VanAccountList { "VanAccounts" : [ ] }`

GET external/account text/xml application/json 200

Resource details.

Description Returns information about the company account that is currently being accessed.

Output

//Class: com.tradeshift.rest.external.CompanyAccountInfo
{
  "CompanyName" : "str",
  "Country" : "str",
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The account state of this company
  "State" : "CREATED",
  "Url" : "str",
  "Description" : "str",
  "Identifiers" : [  ],
  "AddressLines" : [  ],
  "RegistrationAddressLines" : [  ],
  "RegistrationIdentifier" : {
// Company identifier scheme, e.g. DK:CVR, UK:VAT etc. See /external/info/companytypes for a full list.
    "scheme" : "str",
// Value for the company identifier
    "value" : "str"
  },
  "RegistrationCountry" : "str",
// If filled, the limited list of document profiles that the connection will accept.
  "AcceptingDocumentProfiles" : [  ],
  "Properties" : [  ],
  "LookingFor" : null,
  "Offering" : null,
  "LogoURL" : "str",
  "BackgroundURL" : "str",
  "PublicProfile" : "false",
  "NonuserInvoicing" : "false",
  "AutoAcceptConnections" : "false",
// True if only non-sensitive fields are revealed when others retrieve the account
  "Restricted" : "false",
  "NumConnections" : "0",
  "Industry" : "ACADEMIA",
  "OtherIndustry" : "str",
  "OwnershipType" : "SOLE",
  "Size" : "ONE",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Modified" : "2013-07-23T07:35:16.000Z",
  "Phone" : "str",
  "Fax" : "str",
  "ShortUrl" : "str",
  "AccountType" : "FREE"
}

PUT external/account 204400

Resource details.

Description Update company information for the current company account. Properties will not be changed using this resource.

Input

//Class: com.tradeshift.rest.external.CompanyAccountInfo
{
  "CompanyName" : "str",
  "Country" : "str",
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The account state of this company
  "State" : "CREATED",
  "Url" : "str",
  "Description" : "str",
  "Identifiers" : [  ],
  "AddressLines" : [  ],
  "RegistrationAddressLines" : [  ],
  "RegistrationIdentifier" : {
// Company identifier scheme, e.g. DK:CVR, UK:VAT etc. See /external/info/companytypes for a full list.
    "scheme" : "str",
// Value for the company identifier
    "value" : "str"
  },
  "RegistrationCountry" : "str",
// If filled, the limited list of document profiles that the connection will accept.
  "AcceptingDocumentProfiles" : [  ],
  "Properties" : [  ],
  "LookingFor" : null,
  "Offering" : null,
  "LogoURL" : "str",
  "BackgroundURL" : "str",
  "PublicProfile" : "false",
  "NonuserInvoicing" : "false",
  "AutoAcceptConnections" : "false",
// True if only non-sensitive fields are revealed when others retrieve the account
  "Restricted" : "false",
  "NumConnections" : "0",
  "Industry" : "ACADEMIA",
  "OtherIndustry" : "str",
  "OwnershipType" : "SOLE",
  "Size" : "ONE",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Modified" : "2013-07-23T07:35:16.000Z",
  "Phone" : "str",
  "Fax" : "str",
  "ShortUrl" : "str",
  "AccountType" : "FREE"
}

POST external/companies/deletionrequest/instant 201400

Resource details.
Description	Deletes the account instantly. This is only possible for small and recently created accounts.
Returns	204 - The account was deleted. Subsequent requests in the account's context will fail. 400 - The account is not eligible to be deleted instantly. Need to use scheduled deletion. 404 - Invalid company account id

GET external/companies/deletionrequest/type text/plain 200

Resource details.
Description	Get the type of process that applies to the deletion of this company account.
Returns	200 - Returns the process type that applies

GET external/companies/deletionrequest text/xml application/json 200204

Resource details.
Description	Get information about a scheduled deletion of the company account from the request context.
Returns	200 - Returns information about the deletion request. 204 - There is no deletion request for the company from the request context

DELETE external/companies/deletionrequest 204401404

Resource details.
Description	Stop a scheduled deletion. The request still needs to be in state DELETION_REQUESTED.
Returns	204 - The request was removed and the account will not be deleted. 401 - The user from the request context was not authorized to perform this operation. 404 - No pending deletion request was found.

POST external/companies/deletionrequest?delayDays={delayDays} 201400401

Resource details.
Description	Schedule the deletion of the company account (including its users) from the request context.
Parameters	delayDays - The number of days after which the account should be deleted.
Returns	201 - The deletion was scheduled. 400 - A deletion request already exists for the company account from the request context. 401 - The user from the request context was not authorized to perform this operation.

GET external/companies/names/{name}/countries/{country} text/xml application/json 200404

Resource details.
Description	Return a company account by name and country

GET external/companies/{companyAccountId}/accessible 200404

Resource details.
Description	Returns 200 if the current user is a member of the branch or company, otherwise 404

GET external/companies/{companyAccountId}/customers?limit={limit}&page={page}

Resource details.
Output	`//Class: com.tradeshift.customers.CustomerList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Customers" : [ ] }`

PUT external/companies/{companyAccountId}/images/{name} image/jpeg image/png image/gif 201406502

Resource details.

DELETE external/companies/{companyAccountId}/images/{name} 204404

Resource details.

GET external/companies/{companyAccountId}/images/{name}?width={width}&height={height} 304307

Resource details.

GET external/companies/{companyAccountId} text/xml application/json 200

Resource details.

Description Returns information about the requested company account.

Output

//Class: com.tradeshift.rest.external.CompanyAccountInfo
{
  "CompanyName" : "str",
  "Country" : "str",
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The account state of this company
  "State" : "CREATED",
  "Url" : "str",
  "Description" : "str",
  "Identifiers" : [  ],
  "AddressLines" : [  ],
  "RegistrationAddressLines" : [  ],
  "RegistrationIdentifier" : {
// Company identifier scheme, e.g. DK:CVR, UK:VAT etc. See /external/info/companytypes for a full list.
    "scheme" : "str",
// Value for the company identifier
    "value" : "str"
  },
  "RegistrationCountry" : "str",
// If filled, the limited list of document profiles that the connection will accept.
  "AcceptingDocumentProfiles" : [  ],
  "Properties" : [  ],
  "LookingFor" : null,
  "Offering" : null,
  "LogoURL" : "str",
  "BackgroundURL" : "str",
  "PublicProfile" : "false",
  "NonuserInvoicing" : "false",
  "AutoAcceptConnections" : "false",
// True if only non-sensitive fields are revealed when others retrieve the account
  "Restricted" : "false",
  "NumConnections" : "0",
  "Industry" : "ACADEMIA",
  "OtherIndustry" : "str",
  "OwnershipType" : "SOLE",
  "Size" : "ONE",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Modified" : "2013-07-23T07:35:16.000Z",
  "Phone" : "str",
  "Fax" : "str",
  "ShortUrl" : "str",
  "AccountType" : "FREE"
}

GET external/documentfiles/count?directory={directory} 200400

Resource details.
Description	Gets the count of the number of files in a directory
Parameters	directory - the absolute path of the directory to count the number of files in.
Returns	returns the number of files in the directory, 0 if empty or else the appropriate status code. 200 - if the directory is found with the number of files. 400 - if the directory parameter specified does not have a valid value.

PUT external/documentfiles/directory?directory={directory} 204304400403

Resource details.
Description	Creates an empty directory.
Parameters	directory - the absolute path to the directory with the directory name, inside the Tradeshift app folder.
Returns	204 - The directory is created. 304 - The directory with the same name and path already exists. 400 - The directory path supplied is not valid. 403 - A directory cannot be created with this path.

DELETE external/documentfiles/directory?directory={directory} 204304400404403

Resource details.
Description	Deletes the directory passed as parameter, this will fail if the directory is not empty.
Parameters	directory - the absolute path to the directory with the name.
Returns	204 - The directory was deleted. 304 - The directory is not modified and therefore not deleted. 400 - Bad request. Directory name supplied is not valid or is null. 404 - The directory that is to be deleted was not found. 403 - User cannot delete this directory or directories on this path.

POST external/documentfiles/{filename}/dispatcher/van/{vanId}?directory={directory}&rename={rename} text/xml application/json 201204404

Resource details.
Description	Dispatches a documentfile via a given VAN (Value-added-metwork), converting it to UBL and sending it to the inferred receiver.
Parameters	filename - The current filename of the documentfile to dispatch. rename (optional) - A new filename to rename the file to, as part of the dispatch.
Returns	201 - When dispatch was succesfully created (no validation errors). The Location response header will point to the created and dispatched document. The headers contain Last-Modified and Document-ID. 204 - When validation was failed (validation errors can be retrieved using ./errors resource). 404 - When the document was not found.

POST external/documentfiles/{filename}/dispatcher?directory={directory}&rename={rename}&documentSource={documentSource} text/xml application/json 201400403404

Resource details.
Description	Dispatches a documentfile, converting it to UBL and sending it to the inferred receiver.
Parameters	filename - The current filename of the documentfile to dispatch. rename (optional) - A new filename to rename the file to, as part of the dispatch. directory - absolute path to the directory to dispatch file from, for processing.
Returns	201 - When the dispatch was queued. Validation errors might occur after this. Body contains the location of the created resource, headers include Last-Modified and Document-ID. 404 - When the document was not found. 400 - any of the required parameters were not found or were invalid. 403 - if user is not allowed to dispatch files from the specified directory.

GET external/documentfiles/{filename}/errors text/xml 200404

Resource details.
Description	Retrieves any validation errors that occurred when dispatching a document (must have POST to ./dispatcher first).
Parameters	filename - a unique filename of the document file.
Returns	An ErrorResponse structure. 200 - Errors were found for the given document. 404 - no errors were found for this file.

DELETE external/documentfiles/{filename}/file?directory={directory} 204400404

Resource details.
Description	Deletes a document file.
Parameters	filename - a unique filename of the document file. directory - absolute path of the directory where the file is present.
Returns	204 - if the file is deleted. 400 - if the supplied required parameters are blank or are invalid. 404 - if the file to be deleted is not found.

GET external/documentfiles/{filename}/file?directory={directory} */* 200404

Resource details.
Description	Retrieves a previously stored document file.
Parameters	filename - a unique filename of the document file. directory - the absolute path to the directory that has the file.
Returns	200 - when the file was found and the file with its content is returned to the caller. 404 - when file is not found.

PUT external/documentfiles/{filename}/file?directory={directory} */* 204400403415

Resource details.
Description	Stores documentfile - a file content which is a candidate for the Document after successful validations and conversions. Make sure you provide a Content-Type that is in line with the actual content that is being put.The actual document content must be sent as the entity/body of the PUT request.
Parameters	filename - a unique filename of the document file. directory - the absolute path of the directory where the file needs to be put. If the directory does not exist then the directory structure is created. Content-Type - supplied as a header param describing the type of content being uploaded, eg text/xml, text/plain. Content - the actual content supplied as a byte array and part of the body of the request. Content-Range (optional) - sprecified as 'bytes - eg bytes 20-50'supplied as a header param specifying the range of bytes the content represents in the file. This is used for multipart uploads.
Returns	204 - File has been stored. 400 - a required parameter is not supplied or the supplied value is not valid. 403 - adding a file in the supplied directory is not allowed. 415 - the mimetype is not allowed.

POST external/documentfiles/{filename}/move?directory={directory}&newdirectory={newdirectory}&replace={replace} 204400404403

Resource details.
Description	Moves a documentfile to a new folder.
Parameters	directory - the original directory of the file. filename - The current filename of the documentfile to move. newdirectory - Absolute path the directory to move the documentfile to. If the directory does not exist then the directory is created. replace (optional) - if true replaces existing file in new dir with current file.
Returns	204 - if the file was moved to the new directory. 400 - when the supplied arguments are invalid. 404 - when the file to be moved is not found in the original directory. 403 - moving files from or to the supplied directories is not allowed.

POST external/documentfiles/{filename}/rename/{newfilename}/file?directory={directory} text/xml application/json 204304400404

Resource details.
Description	Renames the document file within the same directory.
Parameters	filename - The current filename of the documentfile to rename. newfilename - The new filename to rename the file to. directory - the absolute path of the directory where the file is located.
Returns	204 - the file was renamed 304 - the file was not renamed because a file with the same name new name already exists. 400 - the supplied arguments are not valid. 404 - the file with the original name was not found or the directory does not exist.

GET external/documentfiles?since={since}&createdAfterDate={createdAfterDate}&createdBeforeDate={createdBeforeDate}&limit={limit}&page={page}&state={state}&directory={directory}&filename={filename}&filenameContains={filenameContains}&nopaging={nopaging}&acceptAs={acceptAs}&listDirectories={listDirectories}&listFilesHavingDocumentId={listFilesHavingDocumentId}&recursive={recursive}&orderDesc={orderDesc} text/xml application/json 200400404

Resource details.
Description	Lists document files
Parameters	since (optional) - Limits documents to those which have changed since the given timestamp, formatted as a XSD-timestamp. state (optional) - The state of the document files to show: 'new' for undispatched, 'failed', for ones with validation errors, 'dispatched' for dispatched documents, 'dispatch_failed' for ones where dispatch has failed. directory - The absolute path of the directory to list files from. filename - List of filenames to look for. listDirectories (optional) - List directory definitions including '.' and subdirectories, accepted as values 'true' or 'false'. recursive (optional) - Recursively include subdirectories, accepted as values 'true' or 'false'. orderDesc (optional) - order results in descending order - for time based queries createdAfterDate (optional) - list only those files that were created after this date. createdBeforeDate (optional) - list only those files that were created before this date. limit (optional) - number of files to be shown at once as part of the first page or for every page. page (optional) - number of pages of file names to be fetched. listFilesHavingDocumentId (optional) - list only those files that have an associated document id, accepted as values 'true' or 'false'. nopaging (optional) - to disable any paging and either return all files or just the first few files as specified by the limit parameter. This parameter supersedes the page parameter. acceptAs (optional) - regex file name patterns to use to search for files.
Returns	200 - the directory was found the list of documents found is returned to the caller. 400 - bad request, one or more of the required parameters supplied were either blank or not valid. 404 - the requested directory was not found

GET external/documents/assignments/companies/{companyid}/autoassignments?page={page}&limit={limit}

Resource details.

Output

//Class: com.tradeshift.documents.assignment.AutoAssignmentCompleteInfoList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Items" : [  ]
}

GET external/documents/assignments/companies/{companyid}/deadlines/{datetime}/types/{type}?page={page}&limit={limit}

Resource details.

Output

//Class: com.tradeshift.rest.external.documents.AssignmentPagedList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Assignments" : null
}

GET external/documents/assignments/companies/{companyid}/sparse?page={page}&limit={limit}

Resource details.

Output

//Class: com.tradeshift.rest.external.documents.AssignmentPagedList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Assignments" : null
}

GET external/documents/assignments/companies/{companyid}?page={page}&limit={limit}

Resource details.

Output

//Class: com.tradeshift.rest.external.documents.AssignmentPagedList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Assignments" : null
}

GET external/documents/assignments/documents/{documentid}/assignees/history?locked={locked}

Resource details.
Output	`//Class: com.tradeshift.rest.external.documents.AssigneeHistoryList { "AssigneeHistory" : null }`

GET external/documents/assignments/documents/{documentid}?subjectType={subjectType}

Resource details.

Output

//Class: com.tradeshift.api._public._1.Assignment
// Superclass: com.tradeshift.api._public._1.AssignmentType
{
  "UBLExtensions" : {
    "UBLExtension" : null
  },
  "UBLVersionID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "CustomizationID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "ProfileID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
// The ID or UUID of this document
  "ID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "IssueDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "IssueTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// User that created the assignment, or empty if unknown / system assignment
  "Assigner" : {
    "MarkCareIndicator" : {
      "value" : "false"
    },
    "MarkAttentionIndicator" : {
      "value" : "false"
    },
    "WebsiteURI" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "LogoReferenceID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "EndpointID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "PartyIdentification" : null,
    "PartyName" : null,
    "Language" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "LocaleCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      }
    },
    "PostalAddress" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "AddressTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AddressFormatCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Postbox" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Floor" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Room" : {
        "value" : "str",
        "languageID" : "str"
      },
      "StreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AdditionalStreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BlockName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingNumber" : {
        "value" : "str",
        "languageID" : "str"
      },
      "InhouseMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Department" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkAttention" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkCare" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PlotIdentification" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CitySubdivisionName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CityName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PostalZone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Region" : {
        "value" : "str",
        "languageID" : "str"
      },
      "District" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TimezoneOffset" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AddressLine" : null,
      "Country" : {
        "IdentificationCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "LocationCoordinate" : {
        "CoordinateSystemCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LatitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LongitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      }
    },
    "PhysicalLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "PartyTaxScheme" : null,
    "PartyLegalEntity" : null,
    "Contact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "Person" : {
      "FirstName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "FamilyName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Title" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MiddleName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "NameSuffix" : {
        "value" : "str",
        "languageID" : "str"
      },
      "JobTitle" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OrganizationDepartment" : {
        "value" : "str",
        "languageID" : "str"
      }
    },
    "AgentParty" : null
  },
// List of users that this assignment is assigned to.
  "Assignee" : [  ],
// Document that is being assigned
  "Subject" : {
    "ID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "CopyIndicator" : {
      "value" : "false"
    },
    "UUID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "IssueDate" : {
      "value" : "2011-03-28T22:00:00.000+01:00"
    },
    "DocumentTypeCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "DocumentType" : {
      "value" : "str",
      "languageID" : "str"
    },
    "XPath" : null,
    "Attachment" : {
      "EmbeddedDocumentBinaryObject" : {
        "value" : "[B@7a20c9df",
        "format" : "str",
        "mimeCode" : "APPLICATION_CST_ADATA_XML",
        "encodingCode" : "str",
        "characterSetCode" : "str",
        "uri" : "str",
        "filename" : "str"
      },
      "ExternalReference" : {
        "URI" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "DocumentHash" : {
          "value" : "str",
          "languageID" : "str"
        },
        "ExpiryDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "ExpiryTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        }
      }
    }
  },
// Additional context information about the assignment, e.g. what is expected of the user. App-dependent.
  "Context" : {
    "EmbeddedDocumentBinaryObject" : {
      "value" : "[B@49a8e7cc",
      "format" : "str",
      "mimeCode" : "APPLICATION_CST_ADATA_XML",
      "encodingCode" : "str",
      "characterSetCode" : "str",
      "uri" : "str",
      "filename" : "str"
    },
    "ExternalReference" : {
      "URI" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "DocumentHash" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ExpiryDate" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "ExpiryTime" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      }
    }
  },
// List of assignment delegations mapping (User A delegates it's privileges to User B)
  "Delegation" : [  ],
// Information on when to send out the reminder on this assignment
  "ReminderDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when to send out the reminder on this assignment
  "ReminderTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when to to escalate that this assignment was not executed
  "EscalationDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when to to escalate that this assignment was not executed
  "EscalationTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when the assignment is no longer valid
  "ExpirationDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when the assignment is no longer valid
  "ExpirationTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// The vendor id of the app that is creating the task
  "VendorId" : "str",
// The type of the assignment. An assignment can have the same type with two different namespaces
  "Type" : "str",
// Document that has triggered an assignment. Used for escalated assignments to hold a reference to the initial document
  "OriginalDocumentId" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  }
}

GET external/documents/assignments/groups/{groupId}/users/{userId}/autoassign

Resource details.

Output

//Class: com.tradeshift.rest.external.UserAccountInfo
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root account for this user
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root company name for this user
  "CompanyName" : "str",
  "Username" : "str",
  "Language" : "str",
  "TimeZone" : "str",
  "Memberships" : null,
// When the user was created
  "Created" : "2013-07-23T07:35:16.000Z",
  "State" : "CREATED",
  "Type" : "PERSON",
  "FirstName" : "str",
  "LastName" : "str",
  "Title" : "str",
  "PictureUrl" : "str",
  "Visible" : "false"
}

POST external/documents/assignments/template/{id}?subject={subject}&subjectType={subjectType}&assignee={assignee}&assigner={assigner}&app={app}&component={component}&reminderDeadlineDays={reminderDeadlineDays}&escalationDeadlineDays={escalationDeadlineDays}&expirationDeadlineDays={expirationDeadlineDays}&vendorId={vendorId}&type={type}

Resource details.

Output

//Class: com.tradeshift.api._public._1.Assignment
// Superclass: com.tradeshift.api._public._1.AssignmentType
{
  "UBLExtensions" : {
    "UBLExtension" : null
  },
  "UBLVersionID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "CustomizationID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "ProfileID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
// The ID or UUID of this document
  "ID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "IssueDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "IssueTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// User that created the assignment, or empty if unknown / system assignment
  "Assigner" : {
    "MarkCareIndicator" : {
      "value" : "false"
    },
    "MarkAttentionIndicator" : {
      "value" : "false"
    },
    "WebsiteURI" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "LogoReferenceID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "EndpointID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "PartyIdentification" : null,
    "PartyName" : null,
    "Language" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "LocaleCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      }
    },
    "PostalAddress" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "AddressTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AddressFormatCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Postbox" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Floor" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Room" : {
        "value" : "str",
        "languageID" : "str"
      },
      "StreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AdditionalStreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BlockName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingNumber" : {
        "value" : "str",
        "languageID" : "str"
      },
      "InhouseMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Department" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkAttention" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkCare" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PlotIdentification" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CitySubdivisionName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CityName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PostalZone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Region" : {
        "value" : "str",
        "languageID" : "str"
      },
      "District" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TimezoneOffset" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AddressLine" : null,
      "Country" : {
        "IdentificationCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "LocationCoordinate" : {
        "CoordinateSystemCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LatitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LongitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      }
    },
    "PhysicalLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "PartyTaxScheme" : null,
    "PartyLegalEntity" : null,
    "Contact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "Person" : {
      "FirstName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "FamilyName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Title" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MiddleName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "NameSuffix" : {
        "value" : "str",
        "languageID" : "str"
      },
      "JobTitle" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OrganizationDepartment" : {
        "value" : "str",
        "languageID" : "str"
      }
    },
    "AgentParty" : null
  },
// List of users that this assignment is assigned to.
  "Assignee" : [  ],
// Document that is being assigned
  "Subject" : {
    "ID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "CopyIndicator" : {
      "value" : "false"
    },
    "UUID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "IssueDate" : {
      "value" : "2011-03-28T22:00:00.000+01:00"
    },
    "DocumentTypeCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "DocumentType" : {
      "value" : "str",
      "languageID" : "str"
    },
    "XPath" : null,
    "Attachment" : {
      "EmbeddedDocumentBinaryObject" : {
        "value" : "[B@545232bf",
        "format" : "str",
        "mimeCode" : "APPLICATION_CST_ADATA_XML",
        "encodingCode" : "str",
        "characterSetCode" : "str",
        "uri" : "str",
        "filename" : "str"
      },
      "ExternalReference" : {
        "URI" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "DocumentHash" : {
          "value" : "str",
          "languageID" : "str"
        },
        "ExpiryDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "ExpiryTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        }
      }
    }
  },
// Additional context information about the assignment, e.g. what is expected of the user. App-dependent.
  "Context" : {
    "EmbeddedDocumentBinaryObject" : {
      "value" : "[B@26aec742",
      "format" : "str",
      "mimeCode" : "APPLICATION_CST_ADATA_XML",
      "encodingCode" : "str",
      "characterSetCode" : "str",
      "uri" : "str",
      "filename" : "str"
    },
    "ExternalReference" : {
      "URI" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "DocumentHash" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ExpiryDate" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "ExpiryTime" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      }
    }
  },
// List of assignment delegations mapping (User A delegates it's privileges to User B)
  "Delegation" : [  ],
// Information on when to send out the reminder on this assignment
  "ReminderDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when to send out the reminder on this assignment
  "ReminderTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when to to escalate that this assignment was not executed
  "EscalationDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when to to escalate that this assignment was not executed
  "EscalationTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when the assignment is no longer valid
  "ExpirationDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// Information on when the assignment is no longer valid
  "ExpirationTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
// The vendor id of the app that is creating the task
  "VendorId" : "str",
// The type of the assignment. An assignment can have the same type with two different namespaces
  "Type" : "str",
// Document that has triggered an assignment. Used for escalated assignments to hold a reference to the initial document
  "OriginalDocumentId" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  }
}

PUT external/documents/assignments/users/{fromuserid}/reassignees/{touserid}

Resource details.

GET external/documents/assignments/users/{userId}/autoassign/detail

Resource details.

Output

//Class: com.tradeshift.documents.assignment.AutoAssignmentResponse
{
  "User" : {
    "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root account for this user
    "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root company name for this user
    "CompanyName" : "str",
    "Username" : "str",
    "Language" : "str",
    "TimeZone" : "str",
    "Memberships" : null,
// When the user was created
    "Created" : "2013-07-23T07:35:16.000Z",
    "State" : "CREATED",
    "Type" : "PERSON",
    "FirstName" : "str",
    "LastName" : "str",
    "Title" : "str",
    "PictureUrl" : "str",
    "Visible" : "false"
  },
  "AutoAssignee" : {
    "ExcludeUser" : "false",
    "UserID" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
    "Created" : "2013-07-23T07:35:16.000Z",
    "DelegationType" : "NOT_DELEGATING"
  }
}

PUT external/documents/assignments/users/{userId}/autoassign/{autoAssigneeId}?excludeUser={excludeUser}&isDelegation={isDelegation}

Resource details.

DELETE external/documents/assignments/users/{userId}/autoassign/{autoAssigneeId}?groupId={groupId}

Resource details.

GET external/documents/assignments/users/{userId}/autoassign

Resource details.

Output

//Class: com.tradeshift.rest.external.UserAccountInfo
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root account for this user
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The root company name for this user
  "CompanyName" : "str",
  "Username" : "str",
  "Language" : "str",
  "TimeZone" : "str",
  "Memberships" : null,
// When the user was created
  "Created" : "2013-07-23T07:35:16.000Z",
  "State" : "CREATED",
  "Type" : "PERSON",
  "FirstName" : "str",
  "LastName" : "str",
  "Title" : "str",
  "PictureUrl" : "str",
  "Visible" : "false"
}

GET external/documents/assignments/users/{userId}/autoassigners/detail

Resource details.
Output	`//Class: com.tradeshift.documents.assignment.AutoAssignersResponse { "AutoAssigners" : null }`

GET external/documents/assignments/users/{userid}/sparse?page={page}&limit={limit}&type={type}

Resource details.

Output

//Class: com.tradeshift.rest.external.documents.AssignmentPagedList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Assignments" : null
}

GET external/documents/assignments/users/{userid}/types/{type}/sparse?page={page}&limit={limit}

Resource details.

Output

//Class: com.tradeshift.rest.external.documents.AssignmentPagedList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Assignments" : null
}

GET external/documents/assignments/users/{userid}/types/{type}?page={page}&limit={limit}

Resource details.

Output

//Class: com.tradeshift.rest.external.documents.AssignmentPagedList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Assignments" : null
}

GET external/documents/assignments/users/{userid}?page={page}&limit={limit}&type={type}

Resource details.

Output

//Class: com.tradeshift.rest.external.documents.AssignmentPagedList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Assignments" : null
}

GET external/documents/companies/{owningCompanyAccountId}/{documentId} text/xml application/json application/* 307404

Resource details.

Description

Retrieve a document based on a URI that is the same for both sender and receiver. [Sender] If caller has access to see document identified by {documentId}, then return a redirect to GET document with {documentId}. [Receiver] If not, then check to see if caller has access to a document that has a reference to the supplied {documentId}, and return a redirect to GET document for the document that references {documentId}.

GET external/documents/creditnotes/invoice/{id} text/xml application/json

Resource details.

Output

//Class: com.tradeshift.rest.external.documents.DocumentInfoList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Document" : [  ],
// If a list with totals has been requested, this list will contain the totals per document type and currency.
  "Sums" : null,
// Will be true if the platform is still processing documents. The returned list might not be complete.
  "indexing" : "false"
}

GET external/documents/creditnotes/is-duplicated/{number}?issueDate={issueDate} text/plain

Resource details.

POST external/documents/creditnotes/nextnumber/{documentId}?channel={channel} text/plain 201404

Resource details.

GET external/documents/csv?withouttag={withouttag}&propertykey={propertykey}&propertyvalue={propertyvalue}&ascending={ascending}&type={type}&limit={limit}&stag={stag}&minissuedate={minissuedate}&maxissuedate={maxissuedate}&createdBefore={createdBefore}&createdAfter={createdAfter}&state={state}&ordering={ordering}&sales={sales}&query={query}©Indicator={copyIndicator}&onlycopies={onlycopies}&conversationId={conversationId}&totalFrom={totalFrom}&totalTo={totalTo}¤cy={currency}&businessId={businessId}&accountingSystemId={accountingSystemId}&accountingCost={accountingCost}&populatePersonInfo={populatePersonInfo} application/csv text/csv

Resource details.

POST external/documents/dispatcher?documentId={documentId}&documentProfileId={documentProfileId}&documentSource={documentSource} application/json text/xml text/xml application/xml 201

Resource details.
Description	Store and dispatch the document - the actual document content must be sent as the entity/body of the POST call.The client can decide the UUID for the new element and specify it as the documentId parameter.
Parameters	documentId - A client-generated id for the new document to be dispatched - REQUIRED documentProfileId - the document profile id that the the document adheres to (e.g. "nes.p5.invoice.ubl.2.1.dk"), from the 'documentprofiles' resource - REQUIRED
Returns	201 (Created) Indicates the document was created and dispatched. The Location response header will contain the URI of the dispatch of the new document.

GET external/documents/dispatches?documentId={documentId}&accept={accept} text/xml application/json application/* 200

Resource details.
Description	Get a list of dispatches by object ids
Parameters	documentId - The list of document ids for which the latest dispatch information is retrieved accept - The response Media Type
Returns	The list of dispatch information
Output	`//Class: com.tradeshift.rest.external.documents.ExternalDispatchList { "Dispatches" : null }`

GET external/documents/invoice/is-duplicated/{number}?issueDate={issueDate} text/plain

Resource details.

GET external/documents/invoice/nextnumber text/plain 200

Resource details.
Description	Returns the next invoice number in the series that is not yet used, or nothing if the next invoice number could not be determined. Note that only DISPATCHED documents count as used invoice numbers; drafts, and API-uploaded (but unsent) documents do not count.

GET external/documents/invoices/creditnote/{id}/metadata text/xml application/json

Resource details.

Description Gets invoice metadata for credit note

Output

//Class: com.tradeshift.rest.external.documents.DocumentInfoList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Document" : [  ],
// If a list with totals has been requested, this list will contain the totals per document type and currency.
  "Sums" : null,
// Will be true if the platform is still processing documents. The returned list might not be complete.
  "indexing" : "false"
}

GET external/documents/invoices/creditnote/{id} text/xml application/json

Resource details.

Description Gets invoice for credit note

Output

//Class: oasis.names.specification.ubl.schema.xsd.invoice_2.Invoice
// Superclass: oasis.names.specification.ubl.schema.xsd.invoice_2.InvoiceType
{
  "UBLExtensions" : {
    "UBLExtension" : null
  },
  "UBLVersionID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "CustomizationID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "ProfileID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "ID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "CopyIndicator" : {
    "value" : "false"
  },
  "UUID" : {
    "value" : "str",
    "schemeID" : "str",
    "schemeName" : "str",
    "schemeAgencyID" : "str",
    "schemeAgencyName" : "str",
    "schemeVersionID" : "str",
    "schemeDataURI" : "str",
    "schemeURI" : "str"
  },
  "IssueDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "IssueTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "InvoiceTypeCode" : {
    "value" : "str",
    "listID" : "str",
    "listAgencyID" : "str",
    "listAgencyName" : "str",
    "listName" : "str",
    "listVersionID" : "str",
    "name" : "str",
    "languageID" : "str",
    "listURI" : "str",
    "listSchemeURI" : "str"
  },
  "Note" : null,
  "TaxPointDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "DocumentCurrencyCode" : {
    "value" : "str",
    "listID" : "str",
    "listAgencyID" : "str",
    "listAgencyName" : "str",
    "listName" : "str",
    "listVersionID" : "str",
    "name" : "str",
    "languageID" : "str",
    "listURI" : "str",
    "listSchemeURI" : "str"
  },
  "TaxCurrencyCode" : {
    "value" : "str",
    "listID" : "str",
    "listAgencyID" : "str",
    "listAgencyName" : "str",
    "listName" : "str",
    "listVersionID" : "str",
    "name" : "str",
    "languageID" : "str",
    "listURI" : "str",
    "listSchemeURI" : "str"
  },
  "PricingCurrencyCode" : {
    "value" : "str",
    "listID" : "str",
    "listAgencyID" : "str",
    "listAgencyName" : "str",
    "listName" : "str",
    "listVersionID" : "str",
    "name" : "str",
    "languageID" : "str",
    "listURI" : "str",
    "listSchemeURI" : "str"
  },
  "PaymentCurrencyCode" : {
    "value" : "str",
    "listID" : "str",
    "listAgencyID" : "str",
    "listAgencyName" : "str",
    "listName" : "str",
    "listVersionID" : "str",
    "name" : "str",
    "languageID" : "str",
    "listURI" : "str",
    "listSchemeURI" : "str"
  },
  "PaymentAlternativeCurrencyCode" : {
    "value" : "str",
    "listID" : "str",
    "listAgencyID" : "str",
    "listAgencyName" : "str",
    "listName" : "str",
    "listVersionID" : "str",
    "name" : "str",
    "languageID" : "str",
    "listURI" : "str",
    "listSchemeURI" : "str"
  },
  "AccountingCostCode" : {
    "value" : "str",
    "listID" : "str",
    "listAgencyID" : "str",
    "listAgencyName" : "str",
    "listName" : "str",
    "listVersionID" : "str",
    "name" : "str",
    "languageID" : "str",
    "listURI" : "str",
    "listSchemeURI" : "str"
  },
  "AccountingCost" : {
    "value" : "str",
    "languageID" : "str"
  },
  "LineCountNumeric" : {
    "value" : "0"
  },
  "InvoicePeriod" : null,
  "OrderReference" : {
    "ID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "SalesOrderID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "CopyIndicator" : {
      "value" : "false"
    },
    "UUID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "IssueDate" : {
      "value" : "2011-03-28T22:00:00.000+01:00"
    },
    "IssueTime" : {
      "value" : "2011-03-28T22:00:00.000+01:00"
    },
    "CustomerReference" : {
      "value" : "str",
      "languageID" : "str"
    },
    "DocumentReference" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "CopyIndicator" : {
        "value" : "false"
      },
      "UUID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "IssueDate" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "DocumentTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "DocumentType" : {
        "value" : "str",
        "languageID" : "str"
      },
      "XPath" : null,
      "Attachment" : {
        "EmbeddedDocumentBinaryObject" : {
          "value" : "[B@7edfc76f",
          "format" : "str",
          "mimeCode" : "APPLICATION_CST_ADATA_XML",
          "encodingCode" : "str",
          "characterSetCode" : "str",
          "uri" : "str",
          "filename" : "str"
        },
        "ExternalReference" : {
          "URI" : {
            "value" : "str",
            "schemeID" : "str",
            "schemeName" : "str",
            "schemeAgencyID" : "str",
            "schemeAgencyName" : "str",
            "schemeVersionID" : "str",
            "schemeDataURI" : "str",
            "schemeURI" : "str"
          },
          "DocumentHash" : {
            "value" : "str",
            "languageID" : "str"
          },
          "ExpiryDate" : {
            "value" : "2011-03-28T22:00:00.000+01:00"
          },
          "ExpiryTime" : {
            "value" : "2011-03-28T22:00:00.000+01:00"
          }
        }
      }
    }
  },
  "BillingReference" : null,
  "DespatchDocumentReference" : null,
  "ReceiptDocumentReference" : null,
  "OriginatorDocumentReference" : null,
  "ContractDocumentReference" : null,
  "AdditionalDocumentReference" : null,
  "Signature" : null,
  "AccountingSupplierParty" : {
    "CustomerAssignedAccountID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "AdditionalAccountID" : null,
    "DataSendingCapability" : {
      "value" : "str",
      "languageID" : "str"
    },
    "Party" : {
      "MarkCareIndicator" : {
        "value" : "false"
      },
      "MarkAttentionIndicator" : {
        "value" : "false"
      },
      "WebsiteURI" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "LogoReferenceID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "EndpointID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "PartyIdentification" : null,
      "PartyName" : null,
      "Language" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        },
        "LocaleCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      },
      "PostalAddress" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      },
      "PhysicalLocation" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Description" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Conditions" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "ValidityPeriod" : null,
        "Address" : {
          "ID" : {
            "value" : "str",
            "schemeID" : "str",
            "schemeName" : "str",
            "schemeAgencyID" : "str",
            "schemeAgencyName" : "str",
            "schemeVersionID" : "str",
            "schemeDataURI" : "str",
            "schemeURI" : "str"
          },
          "AddressTypeCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "AddressFormatCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Postbox" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Floor" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Room" : {
            "value" : "str",
            "languageID" : "str"
          },
          "StreetName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "AdditionalStreetName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BlockName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BuildingName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BuildingNumber" : {
            "value" : "str",
            "languageID" : "str"
          },
          "InhouseMail" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Department" : {
            "value" : "str",
            "languageID" : "str"
          },
          "MarkAttention" : {
            "value" : "str",
            "languageID" : "str"
          },
          "MarkCare" : {
            "value" : "str",
            "languageID" : "str"
          },
          "PlotIdentification" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CitySubdivisionName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CityName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "PostalZone" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CountrySubentity" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CountrySubentityCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Region" : {
            "value" : "str",
            "languageID" : "str"
          },
          "District" : {
            "value" : "str",
            "languageID" : "str"
          },
          "TimezoneOffset" : {
            "value" : "str",
            "languageID" : "str"
          },
          "AddressLine" : null,
          "Country" : {
            "IdentificationCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "Name" : {
              "value" : "str",
              "languageID" : "str"
            }
          },
          "LocationCoordinate" : {
            "CoordinateSystemCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "LatitudeDegreesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LatitudeMinutesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LatitudeDirectionCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "LongitudeDegreesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LongitudeMinutesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LongitudeDirectionCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            }
          }
        }
      },
      "PartyTaxScheme" : null,
      "PartyLegalEntity" : null,
      "Contact" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Telephone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Telefax" : {
          "value" : "str",
          "languageID" : "str"
        },
        "ElectronicMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Note" : {
          "value" : "str",
          "languageID" : "str"
        },
        "OtherCommunication" : null
      },
      "Person" : {
        "FirstName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "FamilyName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Title" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MiddleName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "NameSuffix" : {
          "value" : "str",
          "languageID" : "str"
        },
        "JobTitle" : {
          "value" : "str",
          "languageID" : "str"
        },
        "OrganizationDepartment" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "AgentParty" : null
    },
    "DespatchContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "AccountingContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "SellerContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    }
  },
  "AccountingCustomerParty" : {
    "CustomerAssignedAccountID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "SupplierAssignedAccountID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "AdditionalAccountID" : null,
    "Party" : {
      "MarkCareIndicator" : {
        "value" : "false"
      },
      "MarkAttentionIndicator" : {
        "value" : "false"
      },
      "WebsiteURI" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "LogoReferenceID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "EndpointID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "PartyIdentification" : null,
      "PartyName" : null,
      "Language" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        },
        "LocaleCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      },
      "PostalAddress" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      },
      "PhysicalLocation" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Description" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Conditions" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "ValidityPeriod" : null,
        "Address" : {
          "ID" : {
            "value" : "str",
            "schemeID" : "str",
            "schemeName" : "str",
            "schemeAgencyID" : "str",
            "schemeAgencyName" : "str",
            "schemeVersionID" : "str",
            "schemeDataURI" : "str",
            "schemeURI" : "str"
          },
          "AddressTypeCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "AddressFormatCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Postbox" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Floor" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Room" : {
            "value" : "str",
            "languageID" : "str"
          },
          "StreetName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "AdditionalStreetName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BlockName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BuildingName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BuildingNumber" : {
            "value" : "str",
            "languageID" : "str"
          },
          "InhouseMail" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Department" : {
            "value" : "str",
            "languageID" : "str"
          },
          "MarkAttention" : {
            "value" : "str",
            "languageID" : "str"
          },
          "MarkCare" : {
            "value" : "str",
            "languageID" : "str"
          },
          "PlotIdentification" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CitySubdivisionName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CityName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "PostalZone" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CountrySubentity" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CountrySubentityCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Region" : {
            "value" : "str",
            "languageID" : "str"
          },
          "District" : {
            "value" : "str",
            "languageID" : "str"
          },
          "TimezoneOffset" : {
            "value" : "str",
            "languageID" : "str"
          },
          "AddressLine" : null,
          "Country" : {
            "IdentificationCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "Name" : {
              "value" : "str",
              "languageID" : "str"
            }
          },
          "LocationCoordinate" : {
            "CoordinateSystemCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "LatitudeDegreesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LatitudeMinutesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LatitudeDirectionCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "LongitudeDegreesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LongitudeMinutesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LongitudeDirectionCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            }
          }
        }
      },
      "PartyTaxScheme" : null,
      "PartyLegalEntity" : null,
      "Contact" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Telephone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Telefax" : {
          "value" : "str",
          "languageID" : "str"
        },
        "ElectronicMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Note" : {
          "value" : "str",
          "languageID" : "str"
        },
        "OtherCommunication" : null
      },
      "Person" : {
        "FirstName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "FamilyName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Title" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MiddleName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "NameSuffix" : {
          "value" : "str",
          "languageID" : "str"
        },
        "JobTitle" : {
          "value" : "str",
          "languageID" : "str"
        },
        "OrganizationDepartment" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "AgentParty" : null
    },
    "DeliveryContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "AccountingContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "BuyerContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    }
  },
  "PayeeParty" : {
    "MarkCareIndicator" : {
      "value" : "false"
    },
    "MarkAttentionIndicator" : {
      "value" : "false"
    },
    "WebsiteURI" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "LogoReferenceID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "EndpointID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "PartyIdentification" : null,
    "PartyName" : null,
    "Language" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "LocaleCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      }
    },
    "PostalAddress" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "AddressTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AddressFormatCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Postbox" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Floor" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Room" : {
        "value" : "str",
        "languageID" : "str"
      },
      "StreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AdditionalStreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BlockName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingNumber" : {
        "value" : "str",
        "languageID" : "str"
      },
      "InhouseMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Department" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkAttention" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkCare" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PlotIdentification" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CitySubdivisionName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CityName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PostalZone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Region" : {
        "value" : "str",
        "languageID" : "str"
      },
      "District" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TimezoneOffset" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AddressLine" : null,
      "Country" : {
        "IdentificationCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "LocationCoordinate" : {
        "CoordinateSystemCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LatitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LongitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      }
    },
    "PhysicalLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "PartyTaxScheme" : null,
    "PartyLegalEntity" : null,
    "Contact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "Person" : {
      "FirstName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "FamilyName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Title" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MiddleName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "NameSuffix" : {
        "value" : "str",
        "languageID" : "str"
      },
      "JobTitle" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OrganizationDepartment" : {
        "value" : "str",
        "languageID" : "str"
      }
    },
    "AgentParty" : null
  },
  "BuyerCustomerParty" : {
    "CustomerAssignedAccountID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "SupplierAssignedAccountID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "AdditionalAccountID" : null,
    "Party" : {
      "MarkCareIndicator" : {
        "value" : "false"
      },
      "MarkAttentionIndicator" : {
        "value" : "false"
      },
      "WebsiteURI" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "LogoReferenceID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "EndpointID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "PartyIdentification" : null,
      "PartyName" : null,
      "Language" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        },
        "LocaleCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      },
      "PostalAddress" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      },
      "PhysicalLocation" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Description" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Conditions" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "ValidityPeriod" : null,
        "Address" : {
          "ID" : {
            "value" : "str",
            "schemeID" : "str",
            "schemeName" : "str",
            "schemeAgencyID" : "str",
            "schemeAgencyName" : "str",
            "schemeVersionID" : "str",
            "schemeDataURI" : "str",
            "schemeURI" : "str"
          },
          "AddressTypeCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "AddressFormatCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Postbox" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Floor" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Room" : {
            "value" : "str",
            "languageID" : "str"
          },
          "StreetName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "AdditionalStreetName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BlockName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BuildingName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BuildingNumber" : {
            "value" : "str",
            "languageID" : "str"
          },
          "InhouseMail" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Department" : {
            "value" : "str",
            "languageID" : "str"
          },
          "MarkAttention" : {
            "value" : "str",
            "languageID" : "str"
          },
          "MarkCare" : {
            "value" : "str",
            "languageID" : "str"
          },
          "PlotIdentification" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CitySubdivisionName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CityName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "PostalZone" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CountrySubentity" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CountrySubentityCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Region" : {
            "value" : "str",
            "languageID" : "str"
          },
          "District" : {
            "value" : "str",
            "languageID" : "str"
          },
          "TimezoneOffset" : {
            "value" : "str",
            "languageID" : "str"
          },
          "AddressLine" : null,
          "Country" : {
            "IdentificationCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "Name" : {
              "value" : "str",
              "languageID" : "str"
            }
          },
          "LocationCoordinate" : {
            "CoordinateSystemCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "LatitudeDegreesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LatitudeMinutesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LatitudeDirectionCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "LongitudeDegreesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LongitudeMinutesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LongitudeDirectionCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            }
          }
        }
      },
      "PartyTaxScheme" : null,
      "PartyLegalEntity" : null,
      "Contact" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Telephone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Telefax" : {
          "value" : "str",
          "languageID" : "str"
        },
        "ElectronicMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Note" : {
          "value" : "str",
          "languageID" : "str"
        },
        "OtherCommunication" : null
      },
      "Person" : {
        "FirstName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "FamilyName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Title" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MiddleName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "NameSuffix" : {
          "value" : "str",
          "languageID" : "str"
        },
        "JobTitle" : {
          "value" : "str",
          "languageID" : "str"
        },
        "OrganizationDepartment" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "AgentParty" : null
    },
    "DeliveryContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "AccountingContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "BuyerContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    }
  },
  "SellerSupplierParty" : {
    "CustomerAssignedAccountID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "AdditionalAccountID" : null,
    "DataSendingCapability" : {
      "value" : "str",
      "languageID" : "str"
    },
    "Party" : {
      "MarkCareIndicator" : {
        "value" : "false"
      },
      "MarkAttentionIndicator" : {
        "value" : "false"
      },
      "WebsiteURI" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "LogoReferenceID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "EndpointID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "PartyIdentification" : null,
      "PartyName" : null,
      "Language" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        },
        "LocaleCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      },
      "PostalAddress" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      },
      "PhysicalLocation" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Description" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Conditions" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "ValidityPeriod" : null,
        "Address" : {
          "ID" : {
            "value" : "str",
            "schemeID" : "str",
            "schemeName" : "str",
            "schemeAgencyID" : "str",
            "schemeAgencyName" : "str",
            "schemeVersionID" : "str",
            "schemeDataURI" : "str",
            "schemeURI" : "str"
          },
          "AddressTypeCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "AddressFormatCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Postbox" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Floor" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Room" : {
            "value" : "str",
            "languageID" : "str"
          },
          "StreetName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "AdditionalStreetName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BlockName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BuildingName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "BuildingNumber" : {
            "value" : "str",
            "languageID" : "str"
          },
          "InhouseMail" : {
            "value" : "str",
            "languageID" : "str"
          },
          "Department" : {
            "value" : "str",
            "languageID" : "str"
          },
          "MarkAttention" : {
            "value" : "str",
            "languageID" : "str"
          },
          "MarkCare" : {
            "value" : "str",
            "languageID" : "str"
          },
          "PlotIdentification" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CitySubdivisionName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CityName" : {
            "value" : "str",
            "languageID" : "str"
          },
          "PostalZone" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CountrySubentity" : {
            "value" : "str",
            "languageID" : "str"
          },
          "CountrySubentityCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Region" : {
            "value" : "str",
            "languageID" : "str"
          },
          "District" : {
            "value" : "str",
            "languageID" : "str"
          },
          "TimezoneOffset" : {
            "value" : "str",
            "languageID" : "str"
          },
          "AddressLine" : null,
          "Country" : {
            "IdentificationCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "Name" : {
              "value" : "str",
              "languageID" : "str"
            }
          },
          "LocationCoordinate" : {
            "CoordinateSystemCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "LatitudeDegreesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LatitudeMinutesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LatitudeDirectionCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            },
            "LongitudeDegreesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LongitudeMinutesMeasure" : {
              "value" : "0",
              "unitCode" : "str"
            },
            "LongitudeDirectionCode" : {
              "value" : "str",
              "listID" : "str",
              "listAgencyID" : "str",
              "listAgencyName" : "str",
              "listName" : "str",
              "listVersionID" : "str",
              "name" : "str",
              "languageID" : "str",
              "listURI" : "str",
              "listSchemeURI" : "str"
            }
          }
        }
      },
      "PartyTaxScheme" : null,
      "PartyLegalEntity" : null,
      "Contact" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Telephone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Telefax" : {
          "value" : "str",
          "languageID" : "str"
        },
        "ElectronicMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Note" : {
          "value" : "str",
          "languageID" : "str"
        },
        "OtherCommunication" : null
      },
      "Person" : {
        "FirstName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "FamilyName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Title" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MiddleName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "NameSuffix" : {
          "value" : "str",
          "languageID" : "str"
        },
        "JobTitle" : {
          "value" : "str",
          "languageID" : "str"
        },
        "OrganizationDepartment" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "AgentParty" : null
    },
    "DespatchContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "AccountingContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "SellerContact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    }
  },
  "TaxRepresentativeParty" : {
    "MarkCareIndicator" : {
      "value" : "false"
    },
    "MarkAttentionIndicator" : {
      "value" : "false"
    },
    "WebsiteURI" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "LogoReferenceID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "EndpointID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "PartyIdentification" : null,
    "PartyName" : null,
    "Language" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "LocaleCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      }
    },
    "PostalAddress" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "AddressTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AddressFormatCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Postbox" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Floor" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Room" : {
        "value" : "str",
        "languageID" : "str"
      },
      "StreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AdditionalStreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BlockName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingNumber" : {
        "value" : "str",
        "languageID" : "str"
      },
      "InhouseMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Department" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkAttention" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkCare" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PlotIdentification" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CitySubdivisionName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CityName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PostalZone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Region" : {
        "value" : "str",
        "languageID" : "str"
      },
      "District" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TimezoneOffset" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AddressLine" : null,
      "Country" : {
        "IdentificationCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "LocationCoordinate" : {
        "CoordinateSystemCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LatitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LongitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      }
    },
    "PhysicalLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "PartyTaxScheme" : null,
    "PartyLegalEntity" : null,
    "Contact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "Person" : {
      "FirstName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "FamilyName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Title" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MiddleName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "NameSuffix" : {
        "value" : "str",
        "languageID" : "str"
      },
      "JobTitle" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OrganizationDepartment" : {
        "value" : "str",
        "languageID" : "str"
      }
    },
    "AgentParty" : null
  },
  "Delivery" : null,
  "DeliveryTerms" : {
    "ID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "SpecialTerms" : {
      "value" : "str",
      "languageID" : "str"
    },
    "LossRiskResponsibilityCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "LossRisk" : {
      "value" : "str",
      "languageID" : "str"
    },
    "DeliveryLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "AllowanceCharge" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "ChargeIndicator" : {
        "value" : "false"
      },
      "AllowanceChargeReasonCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AllowanceChargeReason" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MultiplierFactorNumeric" : {
        "value" : "0"
      },
      "PrepaidIndicator" : {
        "value" : "false"
      },
      "SequenceNumeric" : {
        "value" : "0"
      },
      "Amount" : {
        "value" : "0",
        "currencyID" : "AZN"
      },
      "BaseAmount" : {
        "value" : "0",
        "currencyID" : "AZN"
      },
      "AccountingCostCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AccountingCost" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TaxCategory" : null,
      "TaxTotal" : {
        "TaxAmount" : {
          "value" : "0",
          "currencyID" : "AZN"
        },
        "RoundingAmount" : {
          "value" : "0",
          "currencyID" : "AZN"
        },
        "TaxEvidenceIndicator" : {
          "value" : "false"
        },
        "TaxSubtotal" : null
      },
      "PaymentMeans" : null
    }
  },
  "PaymentMeans" : null,
  "PaymentTerms" : null,
  "PrepaidPayment" : null,
  "AllowanceCharge" : null,
  "TaxExchangeRate" : {
    "SourceCurrencyCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "SourceCurrencyBaseRate" : {
      "value" : "0"
    },
    "TargetCurrencyCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "TargetCurrencyBaseRate" : {
      "value" : "0"
    },
    "ExchangeMarketID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "CalculationRate" : {
      "value" : "0"
    },
    "MathematicOperatorCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "Date" : {
      "value" : "2011-03-28T22:00:00.000+01:00"
    },
    "ForeignExchangeContract" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "IssueDate" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "IssueTime" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "ContractTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ContractType" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ValidityPeriod" : {
        "StartDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "StartTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "EndDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "EndTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "DurationMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "DescriptionCode" : null,
        "Description" : null
      },
      "ContractDocumentReference" : null
    }
  },
  "PricingExchangeRate" : {
    "SourceCurrencyCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "SourceCurrencyBaseRate" : {
      "value" : "0"
    },
    "TargetCurrencyCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "TargetCurrencyBaseRate" : {
      "value" : "0"
    },
    "ExchangeMarketID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "CalculationRate" : {
      "value" : "0"
    },
    "MathematicOperatorCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "Date" : {
      "value" : "2011-03-28T22:00:00.000+01:00"
    },
    "ForeignExchangeContract" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "IssueDate" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "IssueTime" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "ContractTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ContractType" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ValidityPeriod" : {
        "StartDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "StartTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "EndDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "EndTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "DurationMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "DescriptionCode" : null,
        "Description" : null
      },
      "ContractDocumentReference" : null
    }
  },
  "PaymentExchangeRate" : {
    "SourceCurrencyCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "SourceCurrencyBaseRate" : {
      "value" : "0"
    },
    "TargetCurrencyCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "TargetCurrencyBaseRate" : {
      "value" : "0"
    },
    "ExchangeMarketID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "CalculationRate" : {
      "value" : "0"
    },
    "MathematicOperatorCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "Date" : {
      "value" : "2011-03-28T22:00:00.000+01:00"
    },
    "ForeignExchangeContract" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "IssueDate" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "IssueTime" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "ContractTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ContractType" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ValidityPeriod" : {
        "StartDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "StartTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "EndDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "EndTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "DurationMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "DescriptionCode" : null,
        "Description" : null
      },
      "ContractDocumentReference" : null
    }
  },
  "PaymentAlternativeExchangeRate" : {
    "SourceCurrencyCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "SourceCurrencyBaseRate" : {
      "value" : "0"
    },
    "TargetCurrencyCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "TargetCurrencyBaseRate" : {
      "value" : "0"
    },
    "ExchangeMarketID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "CalculationRate" : {
      "value" : "0"
    },
    "MathematicOperatorCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    },
    "Date" : {
      "value" : "2011-03-28T22:00:00.000+01:00"
    },
    "ForeignExchangeContract" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "IssueDate" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "IssueTime" : {
        "value" : "2011-03-28T22:00:00.000+01:00"
      },
      "ContractTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ContractType" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ValidityPeriod" : {
        "StartDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "StartTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "EndDate" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "EndTime" : {
          "value" : "2011-03-28T22:00:00.000+01:00"
        },
        "DurationMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "DescriptionCode" : null,
        "Description" : null
      },
      "ContractDocumentReference" : null
    }
  },
  "TaxTotal" : null,
  "LegalMonetaryTotal" : {
    "LineExtensionAmount" : {
      "value" : "0",
      "currencyID" : "AZN"
    },
    "TaxExclusiveAmount" : {
      "value" : "0",
      "currencyID" : "AZN"
    },
    "TaxInclusiveAmount" : {
      "value" : "0",
      "currencyID" : "AZN"
    },
    "AllowanceTotalAmount" : {
      "value" : "0",
      "currencyID" : "AZN"
    },
    "ChargeTotalAmount" : {
      "value" : "0",
      "currencyID" : "AZN"
    },
    "PrepaidAmount" : {
      "value" : "0",
      "currencyID" : "AZN"
    },
    "PayableRoundingAmount" : {
      "value" : "0",
      "currencyID" : "AZN"
    },
    "PayableAmount" : {
      "value" : "0",
      "currencyID" : "AZN"
    }
  },
  "InvoiceLine" : null
}

GET external/documents/invoices/is-duplicated/{number}?issueDate={issueDate} text/plain

Resource details.

GET external/documents/invoices/nextnumber/{documentId}?channel={channel} text/plain 200404

Resource details.

GET external/documents/invoices/nextnumber text/plain 200

Resource details.
Description	Returns the next invoice number in the series that is not yet used, or nothing if the next invoice number could not be determined. Note that only DISPATCHED documents count as used invoice numbers; drafts, and API-uploaded (but unsent) documents do not count.

POST external/documents/numbers/seed/{documentTypeName}?channel={channel}&seed={seed}&initnumber={initnumber} text/plain

Resource details.

GET external/documents/numbers/seed/{documentTypeName}?channel={channel} application/json application/xml

Resource details.

GET external/documents/numbers/seeds application/json application/xml

Resource details.

POST external/documents/orders/nextnumber/{documentId}?channel={channel} text/plain 201404

Resource details.

POST external/documents/orders/{number}/close 204404

Resource details.
Description	Closes an order indicating that new invoices should not be submitted against it.

GET external/documents/orders/{number}/closed 404200

Resource details.

Description Get all closed statuses for a given order.

Output

//Class: com.tradeshift.rest.external.close.ExternalOrderClosedStatus
// Superclass: com.tradeshift.rest.external.close.ExternalClosedStatus
{
  "Status" : "CLOSED",
  "Timestamp" : "2013-07-23T07:35:16.000Z"
  "OrderId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "OrderLineClosedStatuses" : [  ]
}

POST external/documents/orders/{number}/closed application/json text/xml 404400204

Resource details.

Description Update all closed statuses for an order. Will replace any previously set closed status for the document.

Input

//Class: com.tradeshift.rest.external.close.ExternalOrderClosedStatus
// Superclass: com.tradeshift.rest.external.close.ExternalClosedStatus
{
  "Status" : "CLOSED",
  "Timestamp" : "2013-07-23T07:35:16.000Z"
  "OrderId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "OrderLineClosedStatuses" : [  ]
}

POST external/documents/orders/{number}/lines/{lineId}/close 204404

Resource details.
Description	Closes an specific line of an order indicating that new invoices should not be submitted against it.

POST external/documents/orders/{number}/lines/{lineId}/open 200404

Resource details.
Description	Opens an order line indicating that new invoices may again be submitted against it.

POST external/documents/orders/{number}/open 204404

Resource details.
Description	Opens an order indicating that new invoices may again be submitted against it.

PUT external/documents/received/{documentId} */* 204400

Resource details.
Description	Import a document as if it has been received at some point. The imported document will be visible, but replies, such as comments, will not be possible.
Parameters	documentId - the new document's id body - any document type supported by the platform. If not UBL, it will be converted automatically to UBL.

GET external/documents/referencing/{documentId} 200404

Resource details.
Description	Get the ID of a document that references supplied documentId. Useful for finding received documents if you have the senders document id as received documents will reference senders document.

POST external/documents/requisitions/nextnumber/{documentId}?channel={channel} text/plain 201404

Resource details.

GET external/documents/{documentId}/attachments/{name}/content */* 200404

Resource details.
Description	Get the content of a single attachment.

DELETE external/documents/{documentId}/attachments/{name}/content 200404

Resource details.
Description	Removes an existing attachment from the document.

PUT external/documents/{documentId}/attachments/{name}/content?type={type}&externalId={externalId} */* 201400415

Resource details.
Description	Add an attachment to the document. Attachments are limited to 10mb.
Parameters	name (required): The name of the attachment. Attachments with the same name are overwritten. type (optional): The type of the attachment. Must be one of 'attachment', 'humanreadableversion', 'sourcedocument' or 'sourcepage'. Defaults to 'attachment'. externalId (optional): The externalId of the attachment. Must be alphanumeric, max length of 36. Special characters allowed are the hyphen and the underscore.

GET external/documents/{documentId}/attachments text/xml application/json 200

Resource details.
Description	Get a list of all attachments for document.
Output	`//Class: com.tradeshift.rest.external.documents.ExternalDocumentAttachmentList { "DocumentAttachment" : [ ] }`

DELETE external/documents/{documentId}/content 204401

Resource details.
Description	Truncate the content for the given document if any exists. This action cannot be revoked or reverted. This is to be used if document content must be permanently wiped, for example for privacy reasons.Truncated documents will have all content except number and issue date removed.All versions of the document will also be truncated including the document attachments.
Parameters	documentId (required): The id of the document to be truncated.

GET external/documents/{documentId}/dispatches/first text/xml application/json application/* 200404

Resource details.
Description	Get the first dispatch information with regards to a previously dispatched document
Parameters	documentId - The document id for which the first dispatch information will be returned
Returns	The Dispatch information

GET external/documents/{documentId}/dispatches/latest text/xml application/json application/* 200404

Resource details.
Description	Get the latest dispatch information with regards to a previously dispatched document
Parameters	documentId - The document id for which the latest dispatch information will be returned
Returns	The Dispatch information

PUT external/documents/{documentId}/dispatches/{dispatchId}?documentSource={documentSource} text/xml application/json 201400404503

Resource details.
Description	Dispatch a previously saved document. The client can decide on the UUID for the new element.
Parameters	documentId - The document id for which the dispatch will be created dispatchId - The newly created dispatch id documentSource - The source of the document used for tracking where the it was dispatched from
Returns	The Dispatch
Input	`//Class: com.tradeshift.rest.external.documents.DispatchRequest { // Connection through which to dispatch the document "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46" }`

GET external/documents/{documentId}/documenttype text/xml application/json

Resource details.

GET external/documents/{documentId}/journal application/x-protobuf;delimited=true;messageType=EventEnvelope

Resource details.

PUT external/documents/{documentId}/lockedstate/{state} 204

Resource details.
Description	Mark a draft document as either sale or purchase if any exists. After this operation, the document cannot be modified in any way.If the 'sent' parameter is set to TRUE then the document will be marked as SALE, otherwise the document will be marked as PURCHASE.
Parameters	state: This parameter indicates if the document should be marked as sent (locked) or not.

GET external/documents/{documentId}/metadata text/xml application/json 200404

Resource details.

Description Get metadata for a document. Metadata cannot be edited.

Output

//Class: com.tradeshift.rest.external.documents.DocumentMetadata
{
  "DocumentId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "DocumentType" : {
    "mimeType" : "str",
// Document profile on which the document is based. This is one of the profiles from the 'documentprofiles' resource.
    "documentProfileId" : "str",
// A document has a type, which can be either 'invoice' or 'creditnote'.
    "type" : "str"
  },
// The conversation in which this document takes place.
  "ConversationId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
/* The state of the document. 
DRAFT - Document is saved as a draft, and not sent yet. 
PROCESSING - Document is being sent to its receiver. 
LOCKED - Document cannot be edited. */
  "State" : "DRAFT",
  "Created" : "2013-07-23T07:35:16.000Z",
  "LastEdit" : "2013-07-23T07:35:16.000Z",
// A hash signature for the content of the document.
  "Hash" : "str",
/* Channel through which the document is dispatched. 
EMAIL - External dispatch to an e-mail address. 
EASYTRADE - External dispatch to the Danish EasyTrade network.
TRADESHIFT - Internal dispatch to another Tradeshift user. */
  "DispatchChannel" : "str",
// The connection through which the document is or will be sent.
  "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Tags" : {
    "Tag" : [  ]
  },
  "PropertyList" : null,
// The Company to which this document was originally sent
  "SentToCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The Company from which this document was originially received
  "ReceivedFromCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The Company to which this document was originially received
  "ReceivedToCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
/* The current dispatch state.
ACCEPTED - The dispatch has been queued for processing.
PROCESSING - The dispatch is currently in progress.
COMPLETED - The dispatch has completed successfully.
FAILED_TRANSIENT - Dispatching failed, but will be retried by system later.
FAILED - Dispatching failed permanently. */
  "DispatchState" : "ACCEPTED",
// Whether this is an incoming (true) or outgoing/draft (false) document.
  "Received" : "false",
/* The PROCESS state of the document (as marked by the user or otherwise). Note that a document won't have a PROCESS state until it is dispatched. 
Possible values: PAID, REJECTED, OVERDUE, ACCEPTED, PENDING, NONE */
  "ProcessState" : "str",
// The DELIVERY state of the document. Possible values: FAILED, SENT, RECEIVED, IN_CLEARANCE, PROCESSING
  "DeliveryState" : "str",
  "OtherPartyState" : "str",
  "UnifiedState" : "UNDETERMINED",
// Base64 encoded document signature. This is only set for documents which have been signed by a 3rd party such as AuthentiDate.
  "Signature" : "str",
// Base64 encoded signature validation report.
  "SignatureValidationReport" : "str",
// Base64 encoded qualified timestamp
  "QualifiedTimestamp" : "str",
  "AllowedActions" : null,
  "AuthorUserId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "OwnerCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "DocumentReference" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Deleted" : "false"
}

GET external/documents/{documentId}/original/responses/{responseId} */* 201202400404500

Resource details.

Description

This resource allows the client to verify the response to an asynchronous import request. The API provides additional information regarding the latest import request of a document. Returns:202 if request is still processing, 201 when request finished successfully with the 'Location' header pointing to the created draft document, 400 for client errors, 401 for unauthorized user accessing the response Id, 404 if the response is not found and500 for internal errors

GET external/documents/{documentId}/original */* 200404

Resource details.
Description	Get the original document before conversion to UBL.

POST external/documents/{documentId}/original?fileName={fileName}&schemaValidateUbl={schemaValidateUbl}&validateDocumentProfile={validateDocumentProfile} */* 202

Resource details.
Description	Asynchronously import a document as as a DRAFT. Returns 202 Accepted with the 'Location' header pointing to a response resource. The client is expected to poll the response resource periodically to get the status of the importNOTE: If importing a PDF only invoices and credit notes are supported, and some errors during conversion can be expected.
Parameters	documentId - the new document's id fileName (optional) - the filename of the original file body - any document type supported by the platform. If not UBL, it will be converted automatically to UBL. schemaValidateUbl - whether to validate the created document against the UBL schema definition, defaults to true validateDocumentProfile - whether to validate the created document against the document profile, defaults to false

GET external/documents/{documentId}/properties/{property} text/plain 200204

Resource details.
Description	Get a property for a document. Gives 204 status when the property is not found.
Parameters	documentId - id of the document whose property is being fetched property - name of the property whose value is being fetched
Returns	The value of the property as plain text.
Output	`//Class: java.lang.String { }`

PUT external/documents/{documentId}/properties/{property} text/plain 201

Resource details.
Description	Add or replace a property for a document. Properties are not visible in the TS user interface, but are shared between API accessors.

DELETE external/documents/{documentId}/properties/{property} 200

Resource details.
Description	Remove a property from a document

GET external/documents/{documentId}/properties 200

Resource details.
Description	Get all document user properties, excluding tags.

GET external/documents/{documentId}/receivercompany text/plain 200204404

Resource details.
Description	Get the receiver company identifier.
Parameters	documentId - The receiver side document id
Returns	The id of the receiver company as plain text.
Output	`//Class: java.lang.String { }`

GET external/documents/{documentId}/senderReferenceId 200404

Resource details.
Description	Get the ID of a document that the supplied document references. Useful for finding senders document id if you have the receivers document id.
Parameters	documentId - The receiver side document id

GET external/documents/{documentId}/sendercompany text/plain 200204404

Resource details.
Description	Get the sender company identifier.
Parameters	documentId - The receiver side document id
Returns	The id of the sender company as plain text.
Output	`//Class: java.lang.String { }`

PUT external/documents/{documentId}/tags/{tag} 201

Resource details.
Description	Add or replace a tag on a document. Tags might be visible in the TS user interface, and are shared between API accessors.
Parameters	documentId - The document id for which the tag will be added tag - The tag value that will be added

DELETE external/documents/{documentId}/tags/{tag} 200

Resource details.
Description	Removes a tag from a document. This will also be removed from the TS user interface.
Parameters	documentId - The document id for which the tag will be removed tag - The tag value that will be removed

GET external/documents/{documentId}/tags text/xml application/json 200404

Resource details.
Description	Get all tags for the specified document.
Returns	The tags
Output	`//Class: com.tradeshift.rest.external.TagList { "Tag" : [ ] }`

GET external/documents/{documentId}/template text/xml application/json 200404

Resource details.
Description	Get the pre-filled template of a document type. This can also be used to return pruned data types
Returns	The pre-filled template

PUT external/documents/{documentId}/vans/{vanId}?documentProfileId={documentProfileId} application/json text/xml text/xml application/xml 201

Resource details.
Description	Store and dispatch the document - the actual document content must be sent as the entity/body of the PUT call.The client must decide the UUID for the new element and specify it as the documentId parameter.
Parameters	documentProfileId: the document profile id that the the document adheres to (e.g. "nes.p5.invoice.ubl.2.1.dk"), from the 'documentprofiles' resource - REQUIRED
Returns	201 (Created) Indicates the document was created and dispatched. The Location response header will contain the URI of the dispatch of the new document.

DELETE external/documents/{documentId} 204404

Resource details.
Description	Delete a previously saved document

PUT external/documents/{documentId}?documentProfileId={documentProfileId}&draft={draft}&validateDocumentProfile={validateDocumentProfile}&schemaValidate={schemaValidate} text/xml application/xml application/vnd.oasis.ubl+json 204400412

Resource details.
Description	Store the document - the actual document content is sent as the entity/body of the PUT call.The client can decide on the UUID for the new element. Attachments in root.AdditionalDocumentReference.Attachment.EmbeddedDocumentBinaryObject will be added to the document. If the document already exists, attachments with already used filename will overwrite previous versions. Attachments with new file names will be appended to the list of attachments on the document. Use the separate attachments resource for deleting attachments.
Parameters	documentProfileId: the document profile id that the the document adheres to (e.g. 'tradeshift.invoice.ubl.1.0'), from the 'documentprofiles' resource - REQUIRED draft (optional): Whether the exact document content becomes the primary source for this document (false) or the Tradeshift-converted form (true). In both cases will the document be uploaded as a DRAFT, and show up as editable in the UI. If you want the document to be non-editable, do a PUT to ./lockedstate after uploading it. schemaValidate (optional): Parameter that indicates if the document should be validated against the UBL schema validateDocumentProfile (optional): Parameter that indicates if the document should be validated or not using the selected document profile.

GET external/documents/{documentId}?locale={locale}&includeDraftAttachments={includeDraftAttachments} text/xml application/pdf application/* 200404

Resource details.
Description	Get a raw UBL document or a PDF representation, based on the Accept-Types header
Parameters	locale (0..1) The render the PDF using this locale; must be a valid 'language-country' or 'language'-only string, where language is a lowercase two-letter ISO-639 code. and country is an uppercase two-letter ISO-3166 code.
Returns	The binary content of the document

GET external/documents/{identifier}/conversationMetadata

Resource details.

Output

//Class: com.tradeshift.documents.dto.conversation.ConversationMetadata
{
  "DocumentId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "AuthorUserId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ConversationId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "DocumentType" : {
    "mimeType" : "str",
    "documentProfileId" : "str",
    "type" : "str",
    "Customization" : null
  },
  "OwnerCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "DocumentReference" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ReceivedFromCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ReceivedToCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "SentToCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46"
}

GET external/documents/{id}/convert?targetDocumentType={targetDocumentType}&targetDocumentTargetType={targetDocumentTargetType}&draft={draft}&withAttachments={withAttachments} text/xml application/json 200401404

Resource details.
Description	Convert a draft document to another type, keeping the same id. Its primary purpose is for when an Invoice or a CreditNote have been created as a draft with the wrong type. targetDocumentType should be either (case-sensitive) 'invoice' or 'creditnote' targetDocumentTargetType is the in the form nes.p5.invoice.ubl.2.1.dk, nes.p5.creditnote.ubl.2.1.dk, or the appropriate country specific targetType.

POST external/documents?documentProfileId={documentProfileId} text/xml 200400412

Resource details.
Description	Validates a document without storing it.

GET external/documents?tag={tag}&useAndOperatorForTags={useAndOperatorForTags}&withouttag={withouttag}&propertykey={propertykey}&propertyvalue={propertyvalue}&useOrOperatorForProperties={useOrOperatorForProperties}&ascending={ascending}&type={type}&page={page}&limit={limit}&id={id}&businessId={businessId}&sentBy={sentBy}&sentTo={sentTo}&stag={stag}&minissuedate={minissuedate}&maxissuedate={maxissuedate}&since={since}&createdBefore={createdBefore}&createdAfter={createdAfter}&processState={processState}&withoutProcessState={withoutProcessState}&branchId={branchId}&totals={totals}&state={state}&ordering={ordering}&sales={sales}&query={query}©Indicator={copyIndicator}&onlycopies={onlycopies}&onlydrafts={onlydrafts}&onlydeleted={onlydeleted}&includesourcedocuments={includesourcedocuments}&waitForIndex={waitForIndex}&_onlyIndex={_onlyIndex}&conversationId={conversationId}&totalFrom={totalFrom}&totalTo={totalTo}¤cy={currency}&requesterId={requesterId}&invoiceTypeCode={invoiceTypeCode}&profileId={profileId}&accountingSystemId={accountingSystemId}&accountingCost={accountingCost}&populatePersonInfo={populatePersonInfo} text/xml application/json 200203400

Resource details.
Description	Gets a list of documents for the current user. If multiple criteria are specified, they act as logical AND, unless specified otherwise. Drafts are not returned by default, unless stag=draft is specified.
Parameters	tag (0..) The tag the document must have. Can be used multiple times, which is interpreted as OR unless you set useAndOperatorForTags to true, then it will be AND. useAndOperatorForTags (0..1) see tag. Defaults to false. withouttag (0..) The tag the document must not have. Can be used multiple times, which is interpreted as AND. propertykey (0..) Must be specified together with propertyvalue. Each pair of propertykey and propertyvalue will be intepreted as AND. propertyvalue (0..) See propertykey. useOrOperatorForProperties (0..) See propertykey. Defaults to false. ascending (0..1) Whether the documents are ordered in ascending or descending order (for last edited date), defaults to descending. type (0..) The type of documents to include. Can be used multiple times, which is interpreted as OR. A document has a type, which can be either 'invoice' or 'creditnote'. page (0..1) Result page to return, defaults to 0. Each page has 'limit' number of results. limit (0..1) Maximum number of results to return, defaults to 25. This is also the number of results on each skipped page. id (0..) The documents to get DocumentInformation for (a Tradeshift UUID value) - Can be used many times. businessId (0..) Limits documents to those with the given business id (invoice/credit note/purchase order number, e.g. 'ABC-123'). Note that business ids are not guaranteed to be unique for received documents, and may potentially be duplicated for different documents, even sent by the same supplier. sentBy (0..1) Sender company tenant id (a Tradeshift UUID value). sentTo (0..1) Receiver company tenant id (a Tradeshift UUID value). stag (0..) The system tag the document must have. Can be used multiple times, which is interpreted as OR. Known system tags: inbox, outbox, draft, sales, purchases, deleted. minissuedate (0..1) Earliest issue date of documents to match (according to UBL content). maxissuedate (0..1) Latest issue date of documents to match (according to UBL content). since (0..1) Limits documents to those which have changed since the given timestamp, formatted as a XSD-timestamp. createdBefore (0..1) Limits documents to those which were created before the given timestamp, formatted as a XSD-timestamp. createdAfter (0..1) Limits documents to those which were created after the given timestamp, formatted as a XSD-timestamp. processState (0..) The _user_ state the document must have (see /metadata). Can be used multiple times, which is interpreted as OR.Note that this parameter is misnamed as it searches among all user states, not just process state. withoutProcessState (0..) The process state the document must not have (see /metadata). Can be used multiple times, which is interpreted as AND.Note that this parameter is misnamed as it searches among all user states, not just process state. branchId (0..) Document business ids. Can be used multiple times, which is interpreted as OR. totals (0..1) Whether to calculate totals or not, defaults to false. state (0..) Document state (e.g. SENT, DELIVERED, ACCEPTED). Can be used multiple times, which is interpreted as OR. ordering (0..1) Result ordering (e.g. DueDate, Amount, Date). Defaults to LastEdit. sales (0..1) Whether document is sale or not. Defaults to null. query (0..1) Text to search. copyIndicator (0..1) Whether to search only copies of documents, originals or both. onlycopies (0..1) Whether to search only on copies of documents. Defaults to false. onlydrafts (0..1) Whether to search only drafts. Defaults to false. onlydeleted (0..1) Whether to search only deleted documents. Defaults to false. includesourcedocuments (0..1) Whether to include the raw UBL document in the result. Defaults to false. Note: the UBL documents are stripped of attachments before they are returned. waitForIndex (0..1) Whether to wait for pending documents to be indexed. Defaults to true. _onlyIndex (0..1) This flag allows document listing using exclusively the data from the index. Defaults to false. conversationId (0..1) The document conversation id used for getting its related documents. totalFrom (0..1) It represents the minimum value of the total range that can be used to filter documents. totalTo (0..1) It represents the maximum value of the total range that can be used to filter documents. currency (0..1) It represents the currency that can be used to filter documents only of that currency. invoiceTypeCode (0..1) This field represents the type of invoice for an invoice document. accountingSystemId(0..) Custom value passed by the user as property to a connection with another company. accountingCost(0..1) The cost center of the document. profileId (0..1) It represents the profile id of a given document. requesterId (0..*) Document's Requester List
Returns	If the request has totals=true, the query will go against a secondary datasource. If this is not completely up to date, 203 will be returned, and the client is expected to retry.

POST external/identifiers/fromubl text/xml application/json application/json text/xml

Resource details.
Description	transform identifiers from ubl scheme
Input	`//Class: com.tradeshift.rest.external.IdentifierList { "Identifiers" : [ ] }`
Output	`//Class: com.tradeshift.rest.external.IdentifierList { "Identifiers" : [ ] }`

POST external/identifiers/toubl text/xml application/json application/json text/xml

Resource details.
Description	transform identifiers to ubl scheme. Unsupported identifiers will be returned untouched.
Input	`//Class: com.tradeshift.rest.external.IdentifierList { "Identifiers" : [ ] }`
Output	`//Class: com.tradeshift.rest.external.IdentifierList { "Identifiers" : [ ] }`

GET external/info/apps/events (view)

Resource details.
Output	`//Class: com.tradeshift.events.rest.EventInfoList { "EventInfos" : [ ] }`

GET external/info/companytypes (view) text/xml application/json

Resource details.
Description	Returns the list of company identifier types that TS currently supports.
Output	`//Class: com.tradeshift.rest.external.CompanyTypeList { "CompanyType" : null }`

GET external/info/countryprofiles/{countryCode} text/xml application/json

Resource details.

Description Returns a specific country profile.

Output

//Class: com.tradeshift.rest.external.CountryProfile
{
// 2-letter country code that uniquely identifies the country.
  "CountryCode" : "str",
  "Name" : "str",
// 3-letter currency code that the country uses.
  "CurrencyCode" : "str",
  "TimeZone" : [  ],
// Unit codes based on UBL specifications. See http://www.schemacentral.com/sc/ubl20/t-clm66411_UnitCodeContentType.html. 
  "UnitCodes" : [  ],
// Unit codes based on UBL specifications. See http://www.schemacentral.com/sc/ubl20/t-clm66411_UnitCodeContentType.html. 
  "SelectedUnitCodes" : [  ],
// Valid company identifiers for this country
  "CompanyIdentifier" : [  ],
// Valid document profiles for this country
  "DocumentProfile" : [  ],
/* Dispatch channels that are available in this country
Channel through which the document is dispatched. 
EMAIL - External dispatch to an e-mail address. 
EASYTRADE - External dispatch to the Danish EasyTrade network.
TRADESHIFT - Internal dispatch to another Tradeshift user. */
  "DispatchChannels" : [  ],
// Company identifier that a sender of an invoice must have in this country.
  "RequiredSenderIdentifiers" : [  ],
  "AddressFormat" : [  ]
}

GET external/info/countryprofiles (view) text/xml application/json

Resource details.
Description	Returns the list of country profiles that TS currently supports.
Output	`//Class: com.tradeshift.rest.external.CountryProfileList { "CountryProfile" : null }`

GET external/info/documentprofiles/{id} text/xml application/json

Resource details.

Description Get a specific document profile.

Output

//Class: com.tradeshift.rest.external.documents.DetailedDocumentProfile
{
  "Description" : {
    "DefaultLanguage" : "str",
    "Labels" : {
      "str" : "str"
    }
  },
  "MaxNumAttachments" : "0",
  "AttachmentRequired" : "false",
  "AllowedAttachmentMimeType" : null,
  "DocumentProfileId" : "str",
  "PaymentMeansCode" : [  ],
  "DocumentType" : "str",
  "DocumentFields" : [  ],
  "RoundingRule" : {
    "RoundingMode" : "UP",
    "RoundingPrecision" : "0",
    "LineRoundingPolicy" : "AGGREGATE_LINE_FRACTIONS"
  }
}

GET external/info/documentprofiles (view) text/xml application/json

Resource details.
Description	Get a list of all supported document profiles, on which uploaded documents must be based.
Output	`//Class: com.tradeshift.rest.external.documents.DetailedDocumentProfileList { "DocumentProfile" : [ ] }`

GET external/info/errorcodes (view) text/xml application/json

Resource details.
Description	Return the list of error codes for the API, which might be given when an API call returns a 4XX HTTP status code.
Output	`//Class: com.tradeshift.rest.external.ErrorCodes { }`

GET external/info/paymentmeans/{id} text/xml application/json

Resource details.
Description	Get a specific payment mean.
Output	`//Class: com.tradeshift.rest.external.ExternalPaymentMeans { "Code" : "str", "DocumentFields" : [ ], "UBLCode" : "str" }`

GET external/info/paymentmeans (view) text/xml application/json

Resource details.
Description	Get a list of all payment means.
Output	`//Class: com.tradeshift.rest.external.ExternalPaymentMeansList { "PaymentMeans" : [ ] }`

GET external/info/status (view)

Resource details.
Output	`//Class: com.tradeshift.rest.external.TradeshiftStatus { "ClusterId" : "str", "EnvironmentName" : "str" }`

GET external/info/taxclasses/{class}/category

Resource details.

GET external/info/taxclasses/{class}/scheme

Resource details.

GET external/info/taxclasses/{class}

Resource details.

Output

//Class: com.tradeshift.info.TaxCategoryClass
{
  "name" : "str",
  "category" : {
    "schemeAgencyId" : "str",
    "schemeId" : "str",
    "schemeVersionId" : "str",
    "ZeroRatedCode" : "str",
    "StandardRatedCode" : "str",
    "ReverseChargedCode" : "str",
    "ReducedRatedCode" : "str",
    "ExemptCode" : "str"
  },
  "scheme" : {
    "schemeAgencyId" : "str",
    "schemeId" : "str",
    "schemeVersionId" : "str"
  },
  "jurisdiction" : {
    "id" : "str",
    "listAgencyID" : "str",
    "listID" : "str",
    "listVersionID" : "str"
  }
}

GET external/info/taxclasses (view)

Resource details.

GET external/info/timezones (view) text/xml application/json

Resource details.
Description	Returns the list of time zones that TS uses.
Output	`//Class: com.tradeshift.rest.external.TimezoneList { "Timezone" : [ ] }`

GET external/info (view) text/xml application/json

Resource details.

POST external/network/connect/{companyAccountId} 201

Resource details.
Description	Create a new connection to specified CompanyAccountID
Returns	Returns the URL of the created connection.

GET external/network/connections/accountingSystemId/{accountingSystemId}?limit={limit}&page={page} text/xml application/json 200400

Resource details.
Description	Search for existing connections by AccountingSystemId.
Parameters	accountingSystemId - externalId that represents connecting company limit - max number of results. MaxLimit enforced to 100 page - requested page
Output	`//Class: com.tradeshift.rest.external.ConnectionSummaryList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Connection" : [ ] }`

PUT external/network/connections/companies/{companyAccountId}/properties/{key} 204

Resource details.
Description	Stores a single value for a property key on the multiple connections that point to a given companyAccountId

GET external/network/connections/companies/{companyAccountId} text/xml application/json 200404

Resource details.

Description Get a connection to a specifiec account. If the current user is connected to the account, the connection will be returned, otherwise 404 will be returned

Output

//Class: com.tradeshift.rest.external.ConnectionDetail
// Superclass: com.tradeshift.rest.external.ConnectionOverview
{
  "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The kind of connection, TradeshiftConnection or ExternalConnection.
  "ConnectionType" : "str",
// The ID of the CompanyAccount that this connection belongs to.
  "FromCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "CompanyName" : "str",
  "City" : "str",
// 2-letter country code that uniquely identifies the country.
  "Country" : "str",
// If filled, the limited list of document profiles IDs that the connection will accept. Only applicable for Tradeshift connections.
  "AcceptingDocumentProfiles" : [  ],
  "FirstName" : "str",
  "LastName" : "str",
  "Title" : "str",
// In case of TradeshiftConnection, contains the ID of the CompanyAccount the connection points to.
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Email" : "str",
  "CountryState" : "str",
  "LookingFor" : null,
  "Offering" : null,
  "Industry" : "ACADEMIA",
  "OtherIndustry" : "str",
/* CREATED - Connection was created, but in't mutual (anymore). 
REQUESTED - Network request sent, but no reply (yet). 
ACCEPTED - This is a mutual connection (network request was accepted). 
 Only applicable for Tradeshift connections. */
  "State" : "CREATED",
  "Properties" : {
    "str" : "str"
  },
  "Sent" : "2013-07-23T07:35:16.000Z",
  "NetworkRequestId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "NetworkRequestType" : "REQUEST",
  "Phone" : "str",
  "Fax" : "str",
  "Identifiers" : [  ],
  "AddressLines" : [  ],
  "ConnectionProperties" : null,
  "InvitationToken" : "str"
  "Url" : "str",
  "Description" : "str",
  "RelationTypes" : [  ]
}

GET external/network/connections/pending?page={page}&limit={limit} text/xml application/json 200

Resource details.
Description	Get a list of pending network requests. The list contains connections which are not yet mutual.
Parameters	limit (optional, default 25) Maximum number of results, and number of results on each skipped page of results page (optional, default 0) Number of result pages to skip
Output	`//Class: com.tradeshift.rest.external.ConnectionList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Connection" : [ ] }`

GET external/network/connections/{connectionId}/detail text/xml application/json 200404

Resource details.

Description Get the details for a connection. Contains the full information on the connection, including names, identifiers, etc.The same structure is returned for both tradeshift and external connections. However, only fields relevant to the connectionkind are filled.

Output

//Class: com.tradeshift.rest.external.ConnectionDetail
// Superclass: com.tradeshift.rest.external.ConnectionOverview
{
  "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
// The kind of connection, TradeshiftConnection or ExternalConnection.
  "ConnectionType" : "str",
// The ID of the CompanyAccount that this connection belongs to.
  "FromCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "CompanyName" : "str",
  "City" : "str",
// 2-letter country code that uniquely identifies the country.
  "Country" : "str",
// If filled, the limited list of document profiles IDs that the connection will accept. Only applicable for Tradeshift connections.
  "AcceptingDocumentProfiles" : [  ],
  "FirstName" : "str",
  "LastName" : "str",
  "Title" : "str",
// In case of TradeshiftConnection, contains the ID of the CompanyAccount the connection points to.
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Email" : "str",
  "CountryState" : "str",
  "LookingFor" : null,
  "Offering" : null,
  "Industry" : "ACADEMIA",
  "OtherIndustry" : "str",
/* CREATED - Connection was created, but in't mutual (anymore). 
REQUESTED - Network request sent, but no reply (yet). 
ACCEPTED - This is a mutual connection (network request was accepted). 
 Only applicable for Tradeshift connections. */
  "State" : "CREATED",
  "Properties" : {
    "str" : "str"
  },
  "Sent" : "2013-07-23T07:35:16.000Z",
  "NetworkRequestId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "NetworkRequestType" : "REQUEST",
  "Phone" : "str",
  "Fax" : "str",
  "Identifiers" : [  ],
  "AddressLines" : [  ],
  "ConnectionProperties" : null,
  "InvitationToken" : "str"
  "Url" : "str",
  "Description" : "str",
  "RelationTypes" : [  ]
}

GET external/network/connections/{connectionId}/documentProfiles/{documentType}/inbound text/xml application/json

Resource details.

Description Get the document profile that would be applied on incoming documents from the account pointed to by a connection

Output

//Class: com.tradeshift.rest.external.documents.DetailedDocumentProfile
{
  "Description" : {
    "DefaultLanguage" : "str",
    "Labels" : {
      "str" : "str"
    }
  },
  "MaxNumAttachments" : "0",
  "AttachmentRequired" : "false",
  "AllowedAttachmentMimeType" : null,
  "DocumentProfileId" : "str",
  "PaymentMeansCode" : [  ],
  "DocumentType" : "str",
  "DocumentFields" : [  ],
  "RoundingRule" : {
    "RoundingMode" : "UP",
    "RoundingPrecision" : "0",
    "LineRoundingPolicy" : "AGGREGATE_LINE_FRACTIONS"
  }
}

GET external/network/connections/{connectionId}/properties/{key} text/plain 200204

Resource details.
Description	Retrieves the value for a single connection property.
Returns	200 (OK) If the property exists on the connection 204 (No Content) If the property does not exist on the connection

DELETE external/network/connections/{connectionId}/properties/{key}

Resource details.
Description	Deletes a property for a given key.

PUT external/network/connections/{connectionId}/properties/{key} text/plain

Resource details.
Description	Stores a single value for a property key, replacing any previous value.

GET external/network/connections/{connectionId}/properties 200204

Resource details.
Description	Retrieves all properties for a connection. Note that one property key can have a list of values.
Returns	200 (OK) If there are any properties on the connection 204 (No Content) If there are no properties on the connection

PUT external/network/connections/{connectionId}/properties text/xml application/json

Resource details.
Description	Replace the existing properties.
Input	`//Class: com.tradeshift.rest.external.ConnectionPropertyList { "Items" : null }`

POST external/network/connections/{connectionId}/properties text/xml application/json

Resource details.
Description	Update the specified properties.
Input	`//Class: com.tradeshift.rest.external.ConnectionPropertyList { "Items" : null }`

POST external/network/connections/{connectionId}/verify 204404

Resource details.
Description	Verify a connection by removing a tag indicating that it's not verified

GET external/network/connections/{connectionId} text/xml application/json 200404

Resource details.

Description Retrieves an existing tradeshift or external connection. The returned structure depends on the kind of connection.

Output

//Class: com.tradeshift.rest.external.ExternalConnection
// Superclass: com.tradeshift.rest.external.AbstractConnection
// Connection to an external (email or easytrade) company.
{
  "ConnectionType": "ExternalConnection",
  "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "CreatedDate" : "2013-07-23T07:35:16.000Z",
  "Properties" : {
    "str" : "str"
  }
  "CompanyName" : "str",
// The country for the external connection. Valid 2-letter country codes are listed in the 'countries' resource.
  "Country" : "str",
  "Modified" : "2013-07-23T07:35:16.000Z",
// Company identifiers. Each identifier's scheme must be one listed in the 'companytypes' resource.
  "Identifiers" : [  ],
  "AddressLines" : [  ],
// Dispatch channel identifier. Supported: EMAIL, EASYTRADE
  "DispatchChannelID" : "EMAIL",
  "FirstName" : "str",
  "LastName" : "str",
  "Email" : "str",
  "Title" : "str",
  "Phone" : "str",
  "Fax" : "str",
  "Language" : "str",
  "TagList" : [  ],
  "Invitation" : {
    "Text" : null,
    "PendingDocumentId" : null,
    "PendingDocumentType" : null,
    "SendMail" : "false"
  }
}


//Class: com.tradeshift.rest.external.TradeshiftConnection
// Superclass: com.tradeshift.rest.external.AbstractConnection
// Connection to another Tradeshift company account (tenant).
{
  "ConnectionType": "TradeshiftConnection",
  "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "CreatedDate" : "2013-07-23T07:35:16.000Z",
  "Properties" : {
    "str" : "str"
  }
  "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
/* CREATED - Connection was created, but in't mutual (anymore). 
REQUESTED - Network request sent, but no reply (yet). 
ACCEPTED - This is a mutual connection (network request was accepted).  */
  "State" : "CREATED"
}

DELETE external/network/connections/{connectionId} 204

Resource details.
Description	Delete an existing connection

PUT external/network/connections/{connectionId}?skipRequest={skipRequest} text/xml application/json 201400

Resource details.
Description	Create a new connection or update an existing one. The connection is either an internal Tradeshift connection or an external connection.
Parameters	Internal connections: the connection structure must contain CompanyAccountId. External connections: there must be a CompanyName, Country (2-letter code, complete list in info/countries resource), DispatchChannelID, FirstName, LastName, Email, Invitation, and AddressLines. Supported schemes for Identifiers can be found in the info/companytypes resource. The address must at least have address lines for the country-specific required schemes.
Returns	Returns the URL of the created connection. The location can in some cases contain another connectionId - this happens when creating a new connection to another Tradeshift user, which already exists.
Input	//Class: com.tradeshift.rest.external.ExternalConnection // Superclass: com.tradeshift.rest.external.AbstractConnection // Connection to an external (email or easytrade) company. { "ConnectionType": "ExternalConnection", "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46", "CreatedDate" : "2013-07-23T07:35:16.000Z", "Properties" : { "str" : "str" } "CompanyName" : "str", // The country for the external connection. Valid 2-letter country codes are listed in the 'countries' resource. "Country" : "str", "Modified" : "2013-07-23T07:35:16.000Z", // Company identifiers. Each identifier's scheme must be one listed in the 'companytypes' resource. "Identifiers" : [ ], "AddressLines" : [ ], // Dispatch channel identifier. Supported: EMAIL, EASYTRADE "DispatchChannelID" : "EMAIL", "FirstName" : "str", "LastName" : "str", "Email" : "str", "Title" : "str", "Phone" : "str", "Fax" : "str", "Language" : "str", "TagList" : [ ], "Invitation" : { "Text" : null, "PendingDocumentId" : null, "PendingDocumentType" : null, "SendMail" : "false" } } //Class: com.tradeshift.rest.external.TradeshiftConnection // Superclass: com.tradeshift.rest.external.AbstractConnection // Connection to another Tradeshift company account (tenant). { "ConnectionType": "TradeshiftConnection", "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46", "CreatedDate" : "2013-07-23T07:35:16.000Z", "Properties" : { "str" : "str" } "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46", /* CREATED - Connection was created, but in't mutual (anymore). REQUESTED - Network request sent, but no reply (yet). ACCEPTED - This is a mutual connection (network request was accepted). */ "State" : "CREATED" }

GET external/network/connections?companyAccountId={companyAccountId}&query={query}&type={type}&passive={passive}&includeProperties={includeProperties}&branchId={branchId}&excludeWithProperty={excludeWithProperty}&excludeWithPropertyValue={excludeWithPropertyValue}&page={page}&limit={limit} text/xml application/json

Resource details.
Description	Returns the connections in the network of the current user according to the query parameter.
Parameters	companyAccountId: Get connections to the specified companyAccountId. query: List of keywords to narrow the results type: (optional, can be either 'TradeshiftConnection' or 'ExternalConnection'): return only connections of this specified type. branchId (optional, default null): Only search for connections in this branch id limit (optional, default 25, max 100): Maximum number of results, and number of results on each skipped page of results. page (optional, default 0): Number of result pages to skip
Output	`//Class: com.tradeshift.rest.external.ConnectionList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Connection" : [ ] }`

POST external/network/groups/connections/delete

Resource details.

Input

//Class: com.tradeshift.connectiongroups.ConnectionGroup
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Name" : "str",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Filters" : null
}

PUT external/network/groups/eval/{id} text/xml application/json

Resource details.

Input

//Class: com.tradeshift.connectiongroups.ConnectionGroup
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Name" : "str",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Filters" : null
}

GET external/network/groups/types text/xml application/json

Resource details.
Output	`//Class: com.tradeshift.connectiongroups.filters.ConnectionFilterTypes { "Types" : null }`

DELETE external/network/groups/{id}/connections/{connectionId}

Resource details.

POST external/network/groups/{id}/connections text/xml application/json

Resource details.
Input	`//Class: com.tradeshift.connectiongroups.rest.ConnectionIdList { "ConnectionIds" : null }`

GET external/network/groups/{id}/connections?limit={limit}&offset={offset} text/xml application/json

Resource details.
Output	`//Class: com.tradeshift.rest.external.ConnectionList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Connection" : [ ] }`

POST external/network/groups/{id}/filters text/xml application/json

Resource details.
Input	`//Class: com.tradeshift.connectiongroups.filters.ConnectionGroupFilters { "Filters" : null }`

GET external/network/groups/{id} text/xml application/json

Resource details.

Output

//Class: com.tradeshift.connectiongroups.ConnectionGroup
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Name" : "str",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Filters" : null
}

DELETE external/network/groups/{id}

Resource details.

PUT external/network/groups/{id} text/xml application/json

Resource details.

Input

//Class: com.tradeshift.connectiongroups.ConnectionGroup
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Name" : "str",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Filters" : null
}

GET external/network/groups?connectionId={connectionId} text/xml application/json

Resource details.

Output

//Class: com.tradeshift.connectiongroups.rest.ConnectionGroupList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Groups" : null
}

POST external/network/groups?limit={limit}&offset={offset} text/xml application/json text/xml application/json

Resource details.

Input

//Class: com.tradeshift.connectiongroups.ConnectionGroup
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Name" : "str",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Filters" : null
}

Output

//Class: com.tradeshift.rest.external.ConnectionList
// Superclass: com.tradeshift.rest.PagedList
{
  "numPages" : "0",
  "pageId" : "0",
  "itemsPerPage" : "0",
  "itemCount" : "0"
  "Connection" : [  ]
}

POST external/network/requests/{connectionId}/accept text/plain

Resource details.
Description	Accepts an existing connection request and marks the connection as accepted with the applicable reverse connection.
Returns	200 (OK) with a new connection ID, if connection request was succesfully accepted 404 (Not Found) if connection request was not accepted or does not exist

GET external/network/suggest?country={country}&companyName={companyName}&identifierScheme={identifierScheme}&identifierValue={identifierValue}&identifierSource={identifierSource}&propertyKey={propertyKey}&propertyValue={propertyValue}&email={email}&limit={limit}&page={page}&existingConnectionsOnly={existingConnectionsOnly} text/xml application/json 200400

Resource details.
Description	Search for existing or potential connections based on criteria. One of the following parameter combinations needs to be provided: country + companyName ; identifierScheme + identifierValue ; propertyKey + propertyValue ; email. All criteria are matched using exact, case-insensitive match unless exactMatch is set as false.
Parameters	country (optional) Must be provided with companyName, to search for an exact company name in a given country. Valid 2-letter country codes are listed in the 'countries' resource. companyName (optional) Must be provided with country, to search for an exact company name in a given country. identifierScheme (optional) Identifier scheme used to identify the company (one of the 'companytypes' resource, e.g. DK:CVR) identifierValue (optional) Company identifier to search for (according to the given identifierScheme) propertyKey (optional) Name of a property set on the connection propertyValue (optional) Value of the specified property name on the connection email (optional) E-mail address of one of the users of the company. limit (optional) Maximum number of results to display, and size of each page to skip. Default: 25. page (optional) Number of pages of results to skip. existingConnectionsOnly (optional) Set 'true' to return only existing connections. 'false' returns only potential connections. Default is to return both. exactMatch (optional) Set 'false' to perform 'fuzzy' string match on company name and property value fields.
Returns	Returns a list of connections matching the criteria. The list can also contain potential connections to other Tradeshift users, these will have a null ConnectionId.
Output	`//Class: com.tradeshift.rest.external.ConnectionList // Superclass: com.tradeshift.rest.PagedList { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Connection" : [ ] }`

GET external/network?query={query}&page={page}&limit={limit} text/xml application/json

Resource details.
Description	Get the user's connections and a list of companies according to the query parameter
Parameters	query List of keywords to narrow the results limit (optional, default 25) Maximum number of results, and number of results on each skipped page of results page (optional, default 0) Number of result pages to skip
Output	`//Class: com.tradeshift.rest.external.NetworkSearchResult { "Connections" : { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Connection" : [ ] }, "Companies" : { "numPages" : "0", "pageId" : "0", "itemsPerPage" : "0", "itemCount" : "0" "Connection" : [ ] } }`

POST external/promotions/{id}/response?response={response}

Resource details.

GET external/promotions/{id}/show-banner

Resource details.

GET external/scanning/email/{connectionId} text/plain

Resource details.

GET external/scanning/receiver

Resource details.

GET external/templates/localizations?draft={draft}

Resource details.
Output	`//Class: com.tradeshift.template.rest.TemplateLocalizationsList { "TemplatesLocalizations" : null }`

GET external/templates/master/fragments/{id}

Resource details.

Output

//Class: com.tradeshift.template.MasterContentFragment
// Superclass: com.tradeshift.template.ContentFragment
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Content" : "str",
  "Type" : "str",
  "Deleted" : "false"
  "Model" : "false",
  "Name" : "str"
}

DELETE external/templates/master/fragments/{id}

Resource details.

PUT external/templates/master/fragments/{id}

Resource details.

Input

//Class: com.tradeshift.template.MasterContentFragment
// Superclass: com.tradeshift.template.ContentFragment
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Content" : "str",
  "Type" : "str",
  "Deleted" : "false"
  "Model" : "false",
  "Name" : "str"
}

GET external/templates/master/fragments

Resource details.
Output	`//Class: com.tradeshift.template.rest.MasterContentFragmentList { "MasterContentFragments" : null }`

GET external/templates/master/localizations?draft={draft}

Resource details.
Output	`//Class: com.tradeshift.template.rest.TemplateLocalizationsList { "TemplatesLocalizations" : null }`

GET external/templates/master/{id}

Resource details.

Output

//Class: com.tradeshift.template.MasterTemplate
// Superclass: com.tradeshift.template.Template
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "LanguageCode" : "str",
  "Name" : "str",
  "ContentFragments" : null,
  "Subject" : "str",
  "Description" : "str",
  "Draft" : "false",
  "LastChanged" : "2013-07-23T07:35:16.000Z",
  "Text" : "str",
  "Deleted" : "false"
}

DELETE external/templates/master/{id}

Resource details.

PUT external/templates/master/{id}

Resource details.

Input

//Class: com.tradeshift.template.MasterTemplate
// Superclass: com.tradeshift.template.Template
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "LanguageCode" : "str",
  "Name" : "str",
  "ContentFragments" : null,
  "Subject" : "str",
  "Description" : "str",
  "Draft" : "false",
  "LastChanged" : "2013-07-23T07:35:16.000Z",
  "Text" : "str",
  "Deleted" : "false"
}

GET external/templates/master?draft={draft}

Resource details.
Output	`//Class: com.tradeshift.template.rest.MasterTemplateList { "MasterTemplates" : null }`

GET external/templates/properties

Resource details.
Output	`//Class: com.tradeshift.template.rest.TemplateProperties { "Properties" : null }`

GET external/templates/rendered/{id}

Resource details.

Output

//Class: com.tradeshift.template.RenderedTemplate
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "RenderedFragments" : null,
  "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "TemplateId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Subject" : "str",
  "HtmlBody" : "str",
  "PlainTextBody" : "str"
}

GET external/templates/{id}/render/preview

Resource details.

Output

//Class: com.tradeshift.template.RenderedTemplate
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "RenderedFragments" : null,
  "ConnectionId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "TemplateId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Subject" : "str",
  "HtmlBody" : "str",
  "PlainTextBody" : "str"
}

GET external/templates/{id}

Resource details.

Output

//Class: com.tradeshift.template.Template
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "LanguageCode" : "str",
  "Name" : "str",
  "ContentFragments" : null,
  "Subject" : "str",
  "Description" : "str",
  "Draft" : "false",
  "LastChanged" : "2013-07-23T07:35:16.000Z",
  "Text" : "str",
  "Deleted" : "false"
}

DELETE external/templates/{id}

Resource details.

PUT external/templates/{id}

Resource details.

Input

//Class: com.tradeshift.template.Template
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ActorId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "GroupId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "LanguageCode" : "str",
  "Name" : "str",
  "ContentFragments" : null,
  "Subject" : "str",
  "Description" : "str",
  "Draft" : "false",
  "LastChanged" : "2013-07-23T07:35:16.000Z",
  "Text" : "str",
  "Deleted" : "false"
}

GET external/templates?draft={draft}

Resource details.
Output	`//Class: com.tradeshift.template.rest.TemplateList { "Templates" : null }`

GET external/urltokens/{idOrString} text/xml application/json

Resource details.
Description	Retrieves a URL Token based on its Id or short representation
Output	`//Class: com.tradeshift.url.UrlToken { "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46", "URL" : "http://tradeshift.com", "Type" : "str", "ShortString" : "str" }`

PUT external/urltokens/{id} text/xml application/json text/xml application/json

Resource details.
Description	Stores a URL Token and returns the stored object. If the URL inside the URL Token already exists, it returns the existing object instead.
Parameters	id: the id for the new Url Token - REQUIRED Url Token: there must be a URL, will be sent as the body of the call - REQUIRED
Returns	Returns the URL Token. The returned object can in some cases contain another id - this happens when the URL inside the given structure already exists.
Input	`//Class: com.tradeshift.url.UrlToken { "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46", "URL" : "http://tradeshift.com", "Type" : "str", "ShortString" : "str" }`
Output	`//Class: com.tradeshift.url.UrlToken { "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46", "URL" : "http://tradeshift.com", "Type" : "str", "ShortString" : "str" }`

POST external/users/authentication/password?expires={expires} text/xml application/json text/xml application/json

Resource details.
Description	Create an authentication JWT
Parameters	userAuthentication - contains the username and password of the user requiring an authentication JWT expires - expiration in seconds from 1 second to 2592000 seconds (30 days)
Returns	200 with response containing the authentication JWT if credentials are valid 401 if credentials are invalid.
Input	`//Class: com.tradeshift.users.rest.UserAuthentication { "Username" : null, "Password" : null }`

POST external/users/authorization text/xml application/json text/xml application/json

Resource details.
Description	Create an authorization JWT
Parameters	httpHeaders - contains the authentication JWT required to generate an authorization JWT
Returns	200 with response containing the authorization JWT if provided Authorization header is well structured with a valid Authentication token. 401 for improperly structured Authorization header or invalid Authentication token.

PUT external/users/byname/{email}/state text/plain 204403

Resource details.

PUT external/users/byname/{name}/memberships

Resource details.
Description	Update users's memberships.
Input	`//Class: com.tradeshift.rest.external.UserMemberships { "UserMembership" : "[]" }`

PUT external/users/byname/{name}?sendActivationMail={sendActivationMail}

Resource details.

Description Creates or updates a user. The user profile must contain the full information for the user. The email in the URL path is ignored.

Input

//Class: com.tradeshift.rest.external.UserProfile
{
  "Company" : {
    "MarkCareIndicator" : {
      "value" : "false"
    },
    "MarkAttentionIndicator" : {
      "value" : "false"
    },
    "WebsiteURI" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "LogoReferenceID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "EndpointID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "PartyIdentification" : null,
    "PartyName" : null,
    "Language" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "LocaleCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      }
    },
    "PostalAddress" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "AddressTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AddressFormatCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Postbox" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Floor" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Room" : {
        "value" : "str",
        "languageID" : "str"
      },
      "StreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AdditionalStreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BlockName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingNumber" : {
        "value" : "str",
        "languageID" : "str"
      },
      "InhouseMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Department" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkAttention" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkCare" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PlotIdentification" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CitySubdivisionName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CityName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PostalZone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Region" : {
        "value" : "str",
        "languageID" : "str"
      },
      "District" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TimezoneOffset" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AddressLine" : null,
      "Country" : {
        "IdentificationCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "LocationCoordinate" : {
        "CoordinateSystemCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LatitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LongitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      }
    },
    "PhysicalLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "PartyTaxScheme" : null,
    "PartyLegalEntity" : null,
    "Contact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "Person" : {
      "FirstName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "FamilyName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Title" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MiddleName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "NameSuffix" : {
        "value" : "str",
        "languageID" : "str"
      },
      "JobTitle" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OrganizationDepartment" : {
        "value" : "str",
        "languageID" : "str"
      }
    },
    "AgentParty" : null
  },
  "PersonParty" : {
    "MarkCareIndicator" : {
      "value" : "false"
    },
    "MarkAttentionIndicator" : {
      "value" : "false"
    },
    "WebsiteURI" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "LogoReferenceID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "EndpointID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "PartyIdentification" : null,
    "PartyName" : null,
    "Language" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "LocaleCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      }
    },
    "PostalAddress" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "AddressTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AddressFormatCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Postbox" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Floor" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Room" : {
        "value" : "str",
        "languageID" : "str"
      },
      "StreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AdditionalStreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BlockName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingNumber" : {
        "value" : "str",
        "languageID" : "str"
      },
      "InhouseMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Department" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkAttention" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkCare" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PlotIdentification" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CitySubdivisionName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CityName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PostalZone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Region" : {
        "value" : "str",
        "languageID" : "str"
      },
      "District" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TimezoneOffset" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AddressLine" : null,
      "Country" : {
        "IdentificationCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "LocationCoordinate" : {
        "CoordinateSystemCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LatitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LongitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      }
    },
    "PhysicalLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "PartyTaxScheme" : null,
    "PartyLegalEntity" : null,
    "Contact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "Person" : {
      "FirstName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "FamilyName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Title" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MiddleName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "NameSuffix" : {
        "value" : "str",
        "languageID" : "str"
      },
      "JobTitle" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OrganizationDepartment" : {
        "value" : "str",
        "languageID" : "str"
      }
    },
    "AgentParty" : null
  },
  "CreationDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "CreationTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "Language" : {
    "ID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "Name" : {
      "value" : "str",
      "languageID" : "str"
    },
    "LocaleCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    }
  }
}

GET external/users/{email}/credentialtypes application/json text/xml

Resource details.

PUT external/users/{userIdOrEmail}?sendActivationMail={sendActivationMail}

Resource details.

Description Creates or updates a user. The user profile must contain the full information for the user. The email in the URL path is ignored.

Input

//Class: com.tradeshift.rest.external.UserProfile
{
  "Company" : {
    "MarkCareIndicator" : {
      "value" : "false"
    },
    "MarkAttentionIndicator" : {
      "value" : "false"
    },
    "WebsiteURI" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "LogoReferenceID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "EndpointID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "PartyIdentification" : null,
    "PartyName" : null,
    "Language" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "LocaleCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      }
    },
    "PostalAddress" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "AddressTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AddressFormatCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Postbox" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Floor" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Room" : {
        "value" : "str",
        "languageID" : "str"
      },
      "StreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AdditionalStreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BlockName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingNumber" : {
        "value" : "str",
        "languageID" : "str"
      },
      "InhouseMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Department" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkAttention" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkCare" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PlotIdentification" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CitySubdivisionName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CityName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PostalZone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Region" : {
        "value" : "str",
        "languageID" : "str"
      },
      "District" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TimezoneOffset" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AddressLine" : null,
      "Country" : {
        "IdentificationCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "LocationCoordinate" : {
        "CoordinateSystemCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LatitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LongitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      }
    },
    "PhysicalLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "PartyTaxScheme" : null,
    "PartyLegalEntity" : null,
    "Contact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "Person" : {
      "FirstName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "FamilyName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Title" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MiddleName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "NameSuffix" : {
        "value" : "str",
        "languageID" : "str"
      },
      "JobTitle" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OrganizationDepartment" : {
        "value" : "str",
        "languageID" : "str"
      }
    },
    "AgentParty" : null
  },
  "PersonParty" : {
    "MarkCareIndicator" : {
      "value" : "false"
    },
    "MarkAttentionIndicator" : {
      "value" : "false"
    },
    "WebsiteURI" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "LogoReferenceID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "EndpointID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "PartyIdentification" : null,
    "PartyName" : null,
    "Language" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "LocaleCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      }
    },
    "PostalAddress" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "AddressTypeCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "AddressFormatCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Postbox" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Floor" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Room" : {
        "value" : "str",
        "languageID" : "str"
      },
      "StreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AdditionalStreetName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BlockName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "BuildingNumber" : {
        "value" : "str",
        "languageID" : "str"
      },
      "InhouseMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Department" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkAttention" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MarkCare" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PlotIdentification" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CitySubdivisionName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CityName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "PostalZone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "Region" : {
        "value" : "str",
        "languageID" : "str"
      },
      "District" : {
        "value" : "str",
        "languageID" : "str"
      },
      "TimezoneOffset" : {
        "value" : "str",
        "languageID" : "str"
      },
      "AddressLine" : null,
      "Country" : {
        "IdentificationCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Name" : {
          "value" : "str",
          "languageID" : "str"
        }
      },
      "LocationCoordinate" : {
        "CoordinateSystemCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LatitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LatitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "LongitudeDegreesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeMinutesMeasure" : {
          "value" : "0",
          "unitCode" : "str"
        },
        "LongitudeDirectionCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        }
      }
    },
    "PhysicalLocation" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Description" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Conditions" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentity" : {
        "value" : "str",
        "languageID" : "str"
      },
      "CountrySubentityCode" : {
        "value" : "str",
        "listID" : "str",
        "listAgencyID" : "str",
        "listAgencyName" : "str",
        "listName" : "str",
        "listVersionID" : "str",
        "name" : "str",
        "languageID" : "str",
        "listURI" : "str",
        "listSchemeURI" : "str"
      },
      "ValidityPeriod" : null,
      "Address" : {
        "ID" : {
          "value" : "str",
          "schemeID" : "str",
          "schemeName" : "str",
          "schemeAgencyID" : "str",
          "schemeAgencyName" : "str",
          "schemeVersionID" : "str",
          "schemeDataURI" : "str",
          "schemeURI" : "str"
        },
        "AddressTypeCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "AddressFormatCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Postbox" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Floor" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Room" : {
          "value" : "str",
          "languageID" : "str"
        },
        "StreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AdditionalStreetName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BlockName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "BuildingNumber" : {
          "value" : "str",
          "languageID" : "str"
        },
        "InhouseMail" : {
          "value" : "str",
          "languageID" : "str"
        },
        "Department" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkAttention" : {
          "value" : "str",
          "languageID" : "str"
        },
        "MarkCare" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PlotIdentification" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CitySubdivisionName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CityName" : {
          "value" : "str",
          "languageID" : "str"
        },
        "PostalZone" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentity" : {
          "value" : "str",
          "languageID" : "str"
        },
        "CountrySubentityCode" : {
          "value" : "str",
          "listID" : "str",
          "listAgencyID" : "str",
          "listAgencyName" : "str",
          "listName" : "str",
          "listVersionID" : "str",
          "name" : "str",
          "languageID" : "str",
          "listURI" : "str",
          "listSchemeURI" : "str"
        },
        "Region" : {
          "value" : "str",
          "languageID" : "str"
        },
        "District" : {
          "value" : "str",
          "languageID" : "str"
        },
        "TimezoneOffset" : {
          "value" : "str",
          "languageID" : "str"
        },
        "AddressLine" : null,
        "Country" : {
          "IdentificationCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "Name" : {
            "value" : "str",
            "languageID" : "str"
          }
        },
        "LocationCoordinate" : {
          "CoordinateSystemCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LatitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LatitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          },
          "LongitudeDegreesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeMinutesMeasure" : {
            "value" : "0",
            "unitCode" : "str"
          },
          "LongitudeDirectionCode" : {
            "value" : "str",
            "listID" : "str",
            "listAgencyID" : "str",
            "listAgencyName" : "str",
            "listName" : "str",
            "listVersionID" : "str",
            "name" : "str",
            "languageID" : "str",
            "listURI" : "str",
            "listSchemeURI" : "str"
          }
        }
      }
    },
    "PartyTaxScheme" : null,
    "PartyLegalEntity" : null,
    "Contact" : {
      "ID" : {
        "value" : "str",
        "schemeID" : "str",
        "schemeName" : "str",
        "schemeAgencyID" : "str",
        "schemeAgencyName" : "str",
        "schemeVersionID" : "str",
        "schemeDataURI" : "str",
        "schemeURI" : "str"
      },
      "Name" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telephone" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Telefax" : {
        "value" : "str",
        "languageID" : "str"
      },
      "ElectronicMail" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Note" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OtherCommunication" : null
    },
    "Person" : {
      "FirstName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "FamilyName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "Title" : {
        "value" : "str",
        "languageID" : "str"
      },
      "MiddleName" : {
        "value" : "str",
        "languageID" : "str"
      },
      "NameSuffix" : {
        "value" : "str",
        "languageID" : "str"
      },
      "JobTitle" : {
        "value" : "str",
        "languageID" : "str"
      },
      "OrganizationDepartment" : {
        "value" : "str",
        "languageID" : "str"
      }
    },
    "AgentParty" : null
  },
  "CreationDate" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "CreationTime" : {
    "value" : "2011-03-28T22:00:00.000+01:00"
  },
  "Language" : {
    "ID" : {
      "value" : "str",
      "schemeID" : "str",
      "schemeName" : "str",
      "schemeAgencyID" : "str",
      "schemeAgencyName" : "str",
      "schemeVersionID" : "str",
      "schemeDataURI" : "str",
      "schemeURI" : "str"
    },
    "Name" : {
      "value" : "str",
      "languageID" : "str"
    },
    "LocaleCode" : {
      "value" : "str",
      "listID" : "str",
      "listAgencyID" : "str",
      "listAgencyName" : "str",
      "listName" : "str",
      "listVersionID" : "str",
      "name" : "str",
      "languageID" : "str",
      "listURI" : "str",
      "listSchemeURI" : "str"
    }
  }
}

PUT external/users/{userId}/memberships

Resource details.
Description	Update users's memberhsips.
Input	`//Class: com.tradeshift.rest.external.UserMemberships { "UserMembership" : "[]" }`

PUT external/users/{userId}/overridingcompanyaccountid text/plain

Resource details.

GET external/users/{userId}/properties/{propertyKey} text/plain

Resource details.

DELETE external/users/{userId}/properties/{propertyKey}

Resource details.

PUT external/users/{userId}/properties/{propertyKey} text/plain

Resource details.

GET external/xsite/signup?callbackURL={callbackURL}&twolegged={twolegged}&email={email}&firstname={firstname}&lastname={lastname}&title={title}&companyName={companyName}&street={street}&buildingnumber={buildingnumber}&locality={locality}&zip={zip}&city={city}&state={state}&recipient={recipient}&country={country}&phone={phone}&fax={fax}&timezone={timezone}&tsRegnoLabel={tsRegnoLabel}&tsRegnoValue={tsRegnoValue}&tsVATLabel={tsVATLabel}&tsVATValue={tsVATValue}&gln={gln}&dkCVR={dkCVR}&gbVAT={gbVAT}&ieVAT={ieVAT}&deSTN={deSTN}&deMWST={deMWST}&atSTN={atSTN}&atMWST={atMWST}&chMWST={chMWST} 307

Resource details.
Description	Start x-site signup process. This call will redirect to tradeshift login, so the user can confirm the signup. The system will verify whether this is an existing or new user, and display the appropriate page. Also refer to the 'countryprofies' resource for an overview of combinations of applicable address fields and identifiers. This request is designed to be generated and OAuth-signed, and then handed to the user's web browser in a link.
Parameters	callbackURL (REQUIRED) URL to redirect to after the activation process has completed twolegged Whether to prefer twolegged OAuth. Set this to false to activate three-legged OAuth. email (REQUIRED) E-mail address of the user firstname (REQUIRED) First name of the user lastname (REQUIRED) Last name of the user title (0..1) Title of the user companyName (REQUIRED) Name of the company street (0..1) Streetname of the address of the company buildingnumber (0..1) House/building number of the address of the company locality (0..1) Locality (SE,AU) of the address of the company zip (0..1) Zip code of the address of the company city (0..1) City of the address of the company state (0..1) State (US) of the address of the company recipient (0..1) Recipient or c/o part (DK) of the address of the company country (REQUIRED) Country of the company (2-letter code from 'countryprofiles' resource) phone (0..1) Phone number of the company fax (0..1) Fax number of the company timezone (0..1) Time zone for the new user, as ID from 'timezones' resource tsRegnoLabel (0..1) Custom company registration identifier (label), must also have tsRegnoValue tsRegnoValue (0..1) Custom company registration identifier (value), must also have tsRegnoLabel tsVATLabel (0..1) Custom value-added tax registration identifier (label), must also have tsVATValue tsVATValue (0..1) Custom value-added tax registration identifier (value), must also have tsVATLabel gln (0..1) GLN (global location number, also known as EAN) company registration identifier dkCVR (0..1) CVR (DK) company registration identifier gbVAT (0..1) VAT (GB) company registration identifier ieVAT (0..1) VAT (GB) company registration identifier deSTN (0..1) STN (DE) company registration identifier deMWST (0..1) MWST (DE) company registration identifier atSTN (0..1) STN (AT) company registration identifier atMWST (0..1) MWST (AT) company registration identifier chMWST (0..1) MWST (CH) company registration identifier
Returns	This resource redirects the user to the TS login / activation page. After activation is complete, the user will be redirected back to [callbackURL], appended with a 'tsCompanyAccountId' query parameter, which will hold the company account id (tenantId) of the newly activated user. If 3-legged OAuth access is requested, an additional 'oauth_token' and 'oauth_token_secret' parameter are added.

POST external/xsite/{identifier}/activate 201404

Resource details.
Description	Activate the user for the given signup request. For existing users, this request must be authenticated for that user. For new users, the request must be unauthenticated.After calling this request, the user should be forwarded to the url in the body of the response.
Returns	URL to forward to

GET external/xsite/{identifier} text/xml application/json 200404

Resource details.

Description Get existing xsite signup request. Take not that an already activated request will have its Activated field set to non-null.

Output

//Class: com.tradeshift.users.dto.XSiteSignup
// Contains the fields for a cross-site signup.
{
  "Id" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "Created" : "2013-07-23T07:35:16.000Z",
  "Activated" : "2013-07-23T07:35:16.000Z",
  "ActivatedCompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
  "ConsumerKey" : "str",
  "ConsumerPurpose" : "str",
  "CallbackURL" : "str",
  "Company" : {
    "CompanyName" : null,
    "Country" : null,
    "Created" : null,
    "Modified" : null,
    "Identifier" : null,
    "AddressLine" : null,
    "Phone" : null,
    "Fax" : null,
    "LegalCompanyStructure" : null,
// If the profile is restricted, and address lines have been stripped off, this will be true. If not restricted, it will be null.
    "AddressAvailable" : null,
    "RegistrationAddress" : null
  },
  "Person" : {
    "Created" : null,
    "Modified" : null,
    "FirstName" : null,
    "LastName" : null,
    "Email" : null,
    "MobileNumber" : null,
    "MobileNumberVerified" : "false",
    "MobileNumberModified" : null,
    "Title" : null
  },
  "Timezone" : "str",
  "Twolegged" : "false",
// Any existing TS company accounts that match the data of this signup. This field is not explicitly stored in te DB.
  "ExistingAccounts" : null,
// Consumer details belonging to the ConsumerKey. This field is not explicitly stored in the DB.
  "Consumer" : {
    "ID" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
    "Name" : "str",
    "Description" : "str",
    "Active" : "false",
// ID of a company account that represents the consumer (if this consumer is linked to a company account)
    "CompanyAccountId" : "58a5b768-08be-48ec-a06d-6874fde8cf46",
    "Keys" : [  ],
    "Access" : [  ]
  }
}