{ "opencollection": "1.0.0", "info": { "name": "Tradeshift External API", "version": "1.0.0" }, "items": [ { "info": { "name": "dx-category--accounts-company", "type": "folder" }, "items": [ { "info": { "name": "Check authorization", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/accesslist/operation/:operationId/type/:typeId/object/:objectId", "params": [ { "name": "operationId", "value": "", "type": "path", "description": "Operation id to be checked" }, { "name": "typeId", "value": "", "type": "path", "description": "Object's type" }, { "name": "objectId", "value": "", "type": "path", "description": "Object id to be checked. \nCould be any type of objects Tradeshift supports (e.g. documentId, dispatchId, conversationId etc.)\n" } ] }, "docs": "Check if an user identified by the tenantId and actorId is able to access the objectId of the type typeId.\nThe operation provided should exist through the list of allowed operations for the role assigned to the user.\nThe result takes into consideration also the DocumentAccess settings, if the app is enabled.\n" }, { "info": { "name": "get account info", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account" }, "docs": "Get information about the company account that is currently being accessed." }, { "info": { "name": "update account info", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account" }, "docs": "Update company information for the current company account. Properties will not be changed using this resource." }, { "info": { "name": "get account info", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/info" }, "docs": "Returns information about the company account that is currently being accessed." }, { "info": { "name": "update account info", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/info", "body": { "type": "json", "data": "{}" } }, "docs": "Update company information for the current company account. Properties will not be changed using this resource." }, { "info": { "name": "get company account", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/:companyId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "UUID identifier of company account." } ] }, "docs": "Return account associated with companyId." }, { "info": { "name": "put company account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/:companyId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "UUID identifier of company account." } ] }, "docs": "Update company information for the specified company account." }, { "info": { "name": "get company identifiers", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/companies/:companyAccountId/identifiers", "params": [ { "name": "companyAccountId", "value": "", "type": "path", "description": "UUID identifier of company (tenant)." } ] }, "docs": "Return identifiers associated with the account with this companyId." }, { "info": { "name": "replace company identifiers", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/companies/:companyAccountId/identifiers", "params": [ { "name": "companyAccountId", "value": "", "type": "path", "description": "UUID identifier of company (tenant)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update company identifiers for the specified company account." } ] }, { "info": { "name": "dx-category--accounts-branches", "type": "folder" }, "items": [ { "info": { "name": "get branches", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/branches" }, "docs": "Get listing of branches for the current company account, if any." }, { "info": { "name": "create branch", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/branches/new", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a company account as the child of the current account using the provided data in the body of the PUT call. The branch will automatically be activated and no activation email will be sent to any branch users attached to the create request. The identifier(s) must not already exist.\n" }, { "info": { "name": "get branch", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/branches/:companyId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "UUID identifier of company account." } ] }, "docs": "Get specific branch for the current parent" }, { "info": { "name": "get parent", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/parent" }, "docs": "Returns information about the parent account of the current account (the parent is the account of which the current account is a branch)." } ] }, { "info": { "name": "dx-category--users-accounts", "type": "folder" }, "items": [ { "info": { "name": "get user info", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/info/user" }, "docs": "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." }, { "info": { "name": "find public users", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/public/users", "params": [ { "name": "q", "value": "", "type": "query", "description": "User to search for" }, { "name": "limit", "value": "", "type": "query", "description": "Page size per query" }, { "name": "page", "value": "", "type": "query", "description": "Page number of the query" } ] }, "docs": "Searches visible users in all companies (not only the current account) for the query string." }, { "info": { "name": "get users", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users", "params": [ { "name": "visible", "value": "", "type": "query", "description": "If true, only display users that are visible to everybody in a network." }, { "name": "limit", "value": "", "type": "query", "description": "Page size per query" }, { "name": "page", "value": "", "type": "query", "description": "Page number of the query" } ] }, "docs": "Get a list of users associated with the current account." }, { "info": { "name": "get user by email", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users/byemail/:email", "params": [ { "name": "email", "value": "", "type": "path", "description": "Email of user being requested" }, { "name": "searchparent", "value": "", "type": "query", "description": "If true, search parent account as well." }, { "name": "searchlocked", "value": "", "type": "query", "description": "If true, search locked account as well." } ] }, "docs": "Find if a user exists inside a company. Case insensitive." }, { "info": { "name": "get user by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." } ] }, "docs": "Gets account information to requested user. Sensitive info is disclosed within the same company or between companies that are mutually connected." }, { "info": { "name": "update user by id", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update a user inside the current company account" }, { "info": { "name": "find users", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/:companyId/users", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "Company (tenant) UUID identifier of company to administer TSGLI prefixes for." }, { "name": "q", "value": "", "type": "query", "description": "User to search for (optional)" }, { "name": "id", "value": "", "type": "query", "description": "list of id's for users to return, if any id' are supplied the q, page and limit params will be ignored" }, { "name": "includeMemberships", "value": "", "type": "query", "description": "adds membership info to found users" }, { "name": "findMembers", "value": "", "type": "query", "description": "consider membership in finding users" }, { "name": "state", "value": "", "type": "query", "description": "state - list of user states to query by, if left out default will be ACTIVE and CREATED" }, { "name": "limit", "value": "", "type": "query", "description": "pagination limit" }, { "name": "page", "value": "", "type": "query", "description": "Page number of the query" } ] }, "docs": "Searches for or lists the users in the requested company account" } ] }, { "info": { "name": "dx-category--users-memberships", "type": "folder" }, "items": [ { "info": { "name": "remove user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/members/:userId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." } ] }, "docs": "Remove a member from the current company account. Users who belong to the account (have the account's CompanyAccountId) cannot be removed." }, { "info": { "name": "replace roles", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users/:userId/role", "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." } ] }, "docs": "Create a membership for the given user, group and role deleting all the existing group's memberships." }, { "info": { "name": "set user state", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users/:userId/state", "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." } ] }, "docs": "Set the state of a user." }, { "info": { "name": "Find user groups by query string", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/usergroups", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of user groups to fetch per call." }, { "name": "page", "value": "", "type": "query", "description": "The page number from which to start fetching the user groups." }, { "name": "state", "value": "", "type": "query", "description": "The state of the user groups." }, { "name": "query", "value": "", "type": "query", "description": "User group name query string." }, { "name": "member", "value": "", "type": "query", "description": "Returned user groups must have the supplied user is as a member." } ] }, "docs": "Gets list of all user groups that the user has access to. Groups are fetched without members\nbut each user group entry will have the number of members it has.\n" }, { "info": { "name": "List of current company branches where the specified user is a member", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/users/:userId/branches", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User account UUID." } ] }, "docs": "Returns a list of branches for the specified user inside organisation hierarchy of his current company.\n" }, { "info": { "name": "List of current company branches starting from current branch where the specified user is a member", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/users/:userId/current/branches", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User account UUID." } ] }, "docs": "Returns a list of branches for the specified user inside organisation hierarchy of his current company.\n" }, { "info": { "name": "remove user membership", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/users/:userId/memberships/:groupId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." }, { "name": "groupId", "value": "", "type": "path", "description": "UUID identifier of the security group" } ] }, "docs": "Remove user's membership to a group." }, { "info": { "name": "Change home branch for a user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/users/:userId/overridingcompanyaccountid", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User account UUID." } ] }, "docs": "Change home company environment which is displayed after the user logs in.\nThe requester must be a company admin and the requester's company must be a parent to the user's company and\noverriding company, otherwise 401 returns.\n" }, { "info": { "name": "Change current primary group and remove old primary group membership", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/users/:userId/primarybranch/:newGroupId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User account UUID." }, { "name": "newGroupId", "value": "", "type": "path", "description": "UUID identifier of the security group" } ] }, "docs": "Change current primary group and remove old primary group membership. The user must be a member of new group.\nThe requester must be a company admin and requester's company must be a parent to user's primary company,\notherwise 401 returns.\n" } ] }, { "info": { "name": "dx-category--accounts-taxes", "type": "folder" }, "items": [ { "info": { "name": "get taxes", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/taxes", "params": [ { "name": "connectionID", "value": "", "type": "query", "description": "Connection to get tax categories for." } ] }, "docs": "Get tax categories. Lists the company taxes for the requesting context, if connectionID is specified it will also include the default tax from the connection properties." }, { "info": { "name": "update taxes", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/taxes" }, "docs": "Update tax categories." } ] }, { "info": { "name": "dx-category--users-profile_images", "type": "folder" }, "items": [ { "info": { "name": "get user image", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users/:userId/images/:name", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." }, { "name": "name", "value": "", "type": "path", "description": "Unique name of image." }, { "name": "height", "value": "", "type": "query", "description": "The height of the image" }, { "name": "width", "value": "", "type": "query", "description": "The width of the image" } ] }, "docs": "Returns image by user and image name." }, { "info": { "name": "save user image", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users/:userId/images/:name", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." }, { "name": "name", "value": "", "type": "path", "description": "Unique name of image." } ] }, "docs": "Save an image by user and image name" }, { "info": { "name": "remove user image", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/users/:userId/images/:name", "params": [ { "name": "userId", "value": "", "type": "path", "description": "UUID identifier of user account." }, { "name": "name", "value": "", "type": "path", "description": "Unique name of image." } ] }, "docs": "Removes image that matches user and image name parameters." } ] }, { "info": { "name": "dx-category--accounts-validations", "type": "folder" }, "items": [ { "info": { "name": "get validations", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations", "params": [ { "name": "id", "value": "", "type": "query", "description": "External (enterprise) ID" } ] }, "docs": "Gets a dynamic validation, by External (enterprise) ID. Only available when the relevant features have been enabled for the account." }, { "info": { "name": "update validations", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations", "params": [ { "name": "id", "value": "", "type": "query", "description": "External (enterprise) ID" } ] }, "docs": "Saves a dynamic validation, by External (enterprise) ID. Only available when the relevant features have been enabled for the account." }, { "info": { "name": "remove validations", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations", "params": [ { "name": "id", "value": "", "type": "query", "description": "External (enterprise) ID" } ] }, "docs": "Deletes a dynamic validation, by External (enterprise) ID. Only available when the relevant features have been enabled for the account." }, { "info": { "name": "validation history", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations/historydata/:historicid", "params": [ { "name": "historicid", "value": "", "type": "path", "description": "Identifier for historical data requested" } ] }, "docs": "Get dynamic validation changes file populated with content." }, { "info": { "name": "list of validations", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations/list", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Page size per query" }, { "name": "page", "value": "", "type": "query", "description": "Page number of the query" } ] }, "docs": "Returns all dynamic validations that have been created for the account. Only available when the relevant features have been enabled for the account." }, { "info": { "name": "validation log", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations/log", "params": [ { "name": "after", "value": "", "type": "query", "description": "List only events after this date." }, { "name": "before", "value": "", "type": "query", "description": "List only events before this date." }, { "name": "limit", "value": "", "type": "query", "description": "Page size per query" }, { "name": "page", "value": "", "type": "query", "description": "Page number of the query" } ] }, "docs": "Returns dynamic validations event log for the account." }, { "info": { "name": "validations used", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations/usedvalues", "params": [ { "name": "after", "value": "", "type": "query", "description": "List only events after this date." }, { "name": "before", "value": "", "type": "query", "description": "List only events before this date." }, { "name": "validationid", "value": "", "type": "query", "description": "Validation to pull events for." }, { "name": "valuesetid", "value": "", "type": "query", "description": "Valueset to pull events for." } ] }, "docs": "Returns dynamic validations event log for the account and validation/valueset." }, { "info": { "name": "validation values", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations/values", "params": [ { "name": "validationid", "value": "", "type": "query", "description": "Identifier of the dynamic validation" }, { "name": "fieldid", "value": "", "type": "query", "description": "Identifier of the field in the dynamic validation" }, { "name": "search", "value": "", "type": "query", "description": "Query string to search" }, { "name": "limit", "value": "", "type": "query", "description": "Page size per query" }, { "name": "page", "value": "", "type": "query", "description": "Page number of the query" } ] }, "docs": "List values currently registered for a given dynamic validation, by the id of the dynamic validation" }, { "info": { "name": "validation value sets", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations/valuesets", "params": [ { "name": "search", "value": "", "type": "query", "description": "Query string to search" }, { "name": "limit", "value": "", "type": "query", "description": "Page size per query" }, { "name": "page", "value": "", "type": "query", "description": "Page number of the query" } ] }, "docs": "List value sets registered for a given dynamic validation, without retrieving actual values." }, { "info": { "name": "validation by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/account/validations/:dynamicvalidationinternalid/values", "params": [ { "name": "dynamicvalidationinternalid", "value": "", "type": "path", "description": "Identifier for dynamic validation" }, { "name": "search", "value": "", "type": "query", "description": "Query string to search" }, { "name": "limit", "value": "", "type": "query", "description": "page size per query" }, { "name": "page", "value": "", "type": "query", "description": "page number of the query" } ] }, "docs": "List all values currently registered for a given dynamic validation." } ] }, { "info": { "name": "dx-category--documents-document_files", "type": "folder" }, "items": [ { "info": { "name": "find document files", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles", "params": [ { "name": "since", "value": "", "type": "query", "description": "Limits documents to those which have changed since the given timestamp, formatted as a ISO 8601 XSD-timestamp.\n" }, { "name": "createdAfter", "value": "", "type": "query", "description": "List only those files that were created after this date." }, { "name": "createdBefore", "value": "", "type": "query", "description": "List only those files that were created before this date." }, { "name": "limit", "value": "", "type": "query", "description": "Number of files to be shown at once as part of the first page or for every page." }, { "name": "noPaging", "value": "", "type": "query", "description": "To disable any paging and either return all files or just the first few files as\nspecified by the limit parameter. This parameter supersedes the page parameter.\n" }, { "name": "recursive", "value": "", "type": "query", "description": "Recursively include subdirectories, accepted as values 'true' or 'false'." }, { "name": "directory", "value": "", "type": "query", "description": "The absolute path of the directory to list files from." }, { "name": "listDirectories", "value": "", "type": "query", "description": "List directory definitions including '.' and subdirectories." }, { "name": "fileNames", "value": "", "type": "query", "description": "List of file names to look for." }, { "name": "acceptAs", "value": "", "type": "query", "description": "Regex file name patterns to use to search for files." }, { "name": "state", "value": "", "type": "query", "description": "The state of the document files to show; 'new' for non dispatched, 'failed', for ones\nwith validation errors, 'dispatched' for dispatched documents, 'dispatch_failed' for\nones where dispatch has failed.\n" }, { "name": "requireDocumentId", "value": "", "type": "query", "description": "List only those files that have an associated document id." }, { "name": "page", "value": "", "type": "query", "description": "Page number of the query" } ] }, "docs": "Get array of document file objects." }, { "info": { "name": "create directory", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/directory", "params": [ { "name": "directory", "value": "", "type": "query", "description": "Full path of directory to create." } ] }, "docs": "Create a new empty directory." }, { "info": { "name": "remove directory", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/directory", "params": [ { "name": "directory", "value": "", "type": "query", "description": "Full path of directory to delete." } ] }, "docs": "Deletes the directory passed as parameter, this will fail if the directory is not empty." }, { "info": { "name": "send file", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/:filename/dispatcher", "params": [ { "name": "filename", "value": "", "type": "path", "description": "Original name of the document file to be renamed" }, { "name": "filename", "value": "", "type": "query", "description": "The current filename of the documentfile to dispatch." }, { "name": "rename", "value": "", "type": "query", "description": "A new filename to rename the file to, as part of the dispatch." }, { "name": "documentSource", "value": "", "type": "query", "description": "Track the document's source - We save the source of the document in a new table called documentsource so that we know where the document was dispatched from." } ] }, "docs": "Dispatches a documentfile, converting it to UBL and sending it to the inferred receiver." }, { "info": { "name": "send file via VAN", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/:filename/dispatcher/van/:vanId", "params": [ { "name": "filename", "value": "", "type": "path", "description": "Original name of the document file to be renamed" }, { "name": "vanId", "value": "", "type": "path", "description": "Identifier of VAN to dispatch documentfile" }, { "name": "filename", "value": "", "type": "query", "description": "The current filename of the documentfile to dispatch." }, { "name": "rename", "value": "", "type": "query", "description": "A new filename to rename the file to, as part of the dispatch." } ] }, "docs": "Dispatches a documentfile via a given VAN (Value-added-network), converting it to UBL and sending it to the inferred receiver." }, { "info": { "name": "error by filename", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/:filename/errors", "params": [ { "name": "filename", "value": "", "type": "path", "description": "Original name of the document file to be renamed" } ] }, "docs": "Retrieves any validation errors that occurred when dispatching a document (must have POST to /dispatcher" }, { "info": { "name": "find file", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/:filename/file", "params": [ { "name": "filename", "value": "", "type": "path", "description": "Original name of the document file to be renamed" }, { "name": "directory", "value": "", "type": "query", "description": "Directory where filename lives." } ] }, "docs": "Retrieves file from a given directory." }, { "info": { "name": "delete file", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/:filename/file", "params": [ { "name": "filename", "value": "", "type": "path", "description": "Original name of the document file to be renamed" }, { "name": "directory", "value": "", "type": "query", "description": "Directory where filename lives." } ] }, "docs": "Deletes a document file." }, { "info": { "name": "move file to folder", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/:filename/move", "params": [ { "name": "filename", "value": "", "type": "path", "description": "Original name of the document file to be renamed" }, { "name": "directory", "value": "", "type": "query", "description": "Directory where file currently lives." }, { "name": "newdirectory", "value": "", "type": "query", "description": "Absolute path the directory to move the documentfile to. If the directory does not exist then the directory is created." }, { "name": "replace", "value": "", "type": "query", "description": "If true, replaces existing file in new directory." } ] }, "docs": "Moves a documentfile to a new folder." }, { "info": { "name": "rename file", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/documentfiles/:filename/rename/:newfilename/file", "params": [ { "name": "filename", "value": "", "type": "path", "description": "Original name of the document file to be renamed" }, { "name": "newfilename", "value": "", "type": "path", "description": "Desired name of the document file being renamed" }, { "name": "directory", "value": "", "type": "query", "description": "Directory where file lives." } ] }, "docs": "Renames the document file within the same directory." } ] }, { "info": { "name": "dx-category--documents-document", "type": "folder" }, "items": [ { "info": { "name": "find documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "tag", "value": "", "type": "query", "description": "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." }, { "name": "useAndOperatorForTags", "value": "", "type": "query", "description": "It sets the tags based search to meet all criteria within the set of provided filters." }, { "name": "withouttag", "value": "", "type": "query", "description": "The tag the document must not have. Can be used multiple times, which is interpreted as AND." }, { "name": "propertykey", "value": "", "type": "query", "description": "Must be specified together with propertyvalue. Each pair of propertykey and propertyvalue will be interpreted as AND by default unless you set useOrOperatorForProperties to true, then it will be OR." }, { "name": "propertyvalue", "value": "", "type": "query", "description": "See propertykey." }, { "name": "useOrOperatorForProperties", "value": "", "type": "query", "description": "It sets the property based search to meet at least one criteria within the set of provided filters." }, { "name": "ascending", "value": "", "type": "query", "description": "Whether the documents are ordered in ascending or descending order (for last edited date), defaults to descending." }, { "name": "type", "value": "", "type": "query", "description": "The type of documents to include. Examples of document types 'invoice', 'creditnote'. Can be used multiple times, which is interpreted as OR." }, { "name": "page", "value": "", "type": "query", "description": "Result page to return. Each page has 'limit' number of results." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. This is also the number of results on each skipped page. Capped to 100. If _onlyIndex is set to true, includesourcedocuments and populatePersonInfo to false value is capped to 10000." }, { "name": "id", "value": "", "type": "query", "description": "The documents to get DocumentInformation for (a Tradeshift UUID value)" }, { "name": "businessId", "value": "", "type": "query", "description": "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." }, { "name": "sentBy", "value": "", "type": "query", "description": "Sender company tenant id (a Tradeshift UUID value)." }, { "name": "sentTo", "value": "", "type": "query", "description": "Receiver company tenant ids (a Tradeshift UUID value)." }, { "name": "stag", "value": "", "type": "query", "description": "The system tag the document must have. Can be used multiple times, which is interpreted as OR. Known system include \"inbox\", \"outbox\", \"draft\", \"sales\", \"purchases\", \"deleted\"." }, { "name": "minissuedate", "value": "", "type": "query", "description": "Earliest issue date of documents to match (according to UBL content)." }, { "name": "maxissuedate", "value": "", "type": "query", "description": "Latest issue date of documents to match (according to UBL content)." }, { "name": "since", "value": "", "type": "query", "description": "Limits documents to those which have changed since the given timestamp, formatted as a XSD-timestamp." }, { "name": "createdBefore", "value": "", "type": "query", "description": "Limits documents to those which were created before the given timestamp, formatted as a XSD-timestamp." }, { "name": "createdAfter", "value": "", "type": "query", "description": "Limits documents to those which were created after the given timestamp, formatted as a XSD-timestamp." }, { "name": "processState", "value": "", "type": "query", "description": "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." }, { "name": "withoutProcessState", "value": "", "type": "query", "description": "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." }, { "name": "branchId", "value": "", "type": "query", "description": "Document business ids. Can be used multiple times, which is interpreted as OR." }, { "name": "totals", "value": "", "type": "query", "description": "Whether to calculate the documents total amount or not." }, { "name": "state", "value": "", "type": "query", "description": "Representing the state (e.g. SENT, DELIVERED, ACCEPTED) of the searched documents.\nCan be used multiple times, which is interpreted as OR.\nAccepted values are: UNDETERMINED, IN_TRANSIT, PENDING_NOT_A_CONTACT, FAILED_DELIVERY, SENT, DELIVERED, ACCEPTED, OVERDUE, PAID_UNCONFIRMED, PAID_CONFIRMED, REJECTED_BY_SENDER, REJECTED_BY_RECEIVER, DISPUTED_BY_RECEIVER, CLOSED, REPLACED, CORRECTED, IN_ENRICHMENT, IN_CLEARANCE, COLLECTED, AWAITING_ASSISTANCE, ASSISTANCE_PROVIDED, CANCELED, ASSISTANCE_CANCELED, PUNCHOUT_SENT, PUNCHOUT_EDIT.\n" }, { "name": "ordering", "value": "", "type": "query", "description": "Field that indicates the criteria on which result will be ordered upon returning (e.g. DueDate, Amount, Date)." }, { "name": "sales", "value": "", "type": "query", "description": "This parameter decides whether the transaction type of selected documents should be sale or not." }, { "name": "query", "value": "", "type": "query", "description": "This parameter defines the specific text to be searched within the documents. It can include a single or\nmultiple words or phrases and documents that match the search condition will be returned.\n" }, { "name": "copyIndicator", "value": "", "type": "query", "description": "Whether to search only copies of documents, originals or both." }, { "name": "onlycopies", "value": "", "type": "query", "description": "Whether to search only copies of documents." }, { "name": "onlydrafts", "value": "", "type": "query", "description": "Whether to search only drafts." }, { "name": "onlydeleted", "value": "", "type": "query", "description": "Whether to search only deleted documents." }, { "name": "includesourcedocuments", "value": "", "type": "query", "description": "Whether to include the raw UBL document in the result. The UBL documents are stripped of attachments before they are returned." }, { "name": "waitForIndex", "value": "", "type": "query", "description": "Whether to wait for pending documents to be indexed." }, { "name": "_onlyIndex", "value": "", "type": "query", "description": "This flag allows document listing using exclusively the data from the index." }, { "name": "conversationId", "value": "", "type": "query", "description": "The document conversation id used for getting its related documents." }, { "name": "totalFrom", "value": "", "type": "query", "description": "It represents the minimum value of the total range that can be used to filter documents." }, { "name": "totalTo", "value": "", "type": "query", "description": "It represents the maximum value of the total range that can be used to filter documents." }, { "name": "currency", "value": "", "type": "query", "description": "It represents the currency that can be used to filter documents only of that currency." }, { "name": "requesterId", "value": "", "type": "query", "description": "This field can be used to filter documents by the given list of requester Ids, only applicable for Purchase Request Documents. The requester is either the creating person or the document or if specified the \"on behalf of\" person\n" }, { "name": "invoiceTypeCode", "value": "", "type": "query", "description": "This field represents the type of invoice for an invoice document. If the field is missing then we will have a normal/commercial invoice filter. For value 325 proforma invoice type will be searched and for value 386 we will have prepayment invoice.\n" }, { "name": "accountingSystemId", "value": "", "type": "query", "description": "This field represents a custom value assigned by a client to a connection with a supplier.\n" }, { "name": "accountingCost", "value": "", "type": "query", "description": "This field represents a custom value assigned by a client refering to a Cost Center." }, { "name": "profileId", "value": "", "type": "query", "description": "It represents the profile id of a given document." }, { "name": "populatePersonInfo", "value": "", "type": "query", "description": "Populate person info (actor and requester)" }, { "name": "orderTypeCode", "value": "", "type": "query", "description": "This field represents the type of order for an order document." }, { "name": "orderChangeTypeCode", "value": "", "type": "query", "description": "This field represents the type of order for an order change document." } ] }, "docs": "Gets a list of documents for the current user in XML or JSON format depending on the request Accept header. If multiple criteria are specified, they act as logical AND, unless specified otherwise. Drafts are not returned by default, unless stag=draft is specified. The return list of documents can be sorted by DueDate, LastEdit, Number, Amount, Date, Type." }, { "info": { "name": "Get company document", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/companies/:owningCompanyId/:documentId", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "owningCompanyId", "value": "", "type": "path", "description": "UUID identifier of company account owning the document." }, { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" } ] }, "docs": "Retrieves a document in the context of an owning company. If the supplied authentication context has access to\nsee document identified by {documentId}, meaning the sender of the document, then returns a redirect to GET the document with {documentId}.\nIf the supplied authentication context does not have access to the document, then checks to see if it has\naccess to a document that references the supplied {documentId}, and returns a redirect to GET that referencing document instead.\nThis endpoint " }, { "info": { "name": "find documents (CSV support)", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/csv", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "tag", "value": "", "type": "query", "description": "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." }, { "name": "useAndOperatorForTags", "value": "", "type": "query", "description": "It sets the tags based search to meet all criteria within the set of provided filters." }, { "name": "withouttag", "value": "", "type": "query", "description": "The tag the document must not have. Can be used multiple times, which is interpreted as AND." }, { "name": "propertykey", "value": "", "type": "query", "description": "Must be specified together with propertyvalue. Each pair of propertykey and propertyvalue will be interpreted as AND." }, { "name": "propertyvalue", "value": "", "type": "query", "description": "See propertykey." }, { "name": "ascending", "value": "", "type": "query", "description": "Whether the documents are ordered in ascending or descending order (for last edited date), defaults to descending." }, { "name": "type", "value": "", "type": "query", "description": "The type of documents to include. Can be used multiple times, which is interpreted as OR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. This is also the number of results on each skipped page." }, { "name": "stag", "value": "", "type": "query", "description": "The system tag the document must have. Can be used multiple times, which is interpreted as OR. Known system include \"inbox\", \"outbox\", \"draft\", \"sales\", \"purchases\", \"deleted\"." }, { "name": "minissuedate", "value": "", "type": "query", "description": "Earliest issue date of documents to match (according to UBL content)." }, { "name": "maxissuedate", "value": "", "type": "query", "description": "Latest issue date of documents to match (according to UBL content)." }, { "name": "createdBefore", "value": "", "type": "query", "description": "Limits documents to those which were created before the given timestamp, formatted as a XSD-timestamp." }, { "name": "createdAfter", "value": "", "type": "query", "description": "Limits documents to those which were created after the given timestamp, formatted as a XSD-timestamp." }, { "name": "state", "value": "", "type": "query", "description": "Represents the state (e.g. SENT, DELIVERED, ACCEPTED) of the searched documents.\nCan be used multiple times, which is interpreted as OR.\nAccepted values are: UNDETERMINED, IN_TRANSIT, PENDING_NOT_A_CONTACT, FAILED_DELIVERY, SENT, DELIVERED, ACCEPTED, OVERDUE, PAID_UNCONFIRMED, PAID_CONFIRMED, REJECTED_BY_SENDER, REJECTED_BY_RECEIVER, DISPUTED_BY_RECEIVER, CLOSED, REPLACED, AWAITING_ASSISTANCE, ASSISTANCE_PROVIDED, CANCELED, ASSISTANCE_CANCELED, PUNCHOUT_SENT, PUNCHOUT_EDIT.\n" }, { "name": "ordering", "value": "", "type": "query", "description": "Result ordering (e.g. DueDate, Amount, Date)." }, { "name": "sales", "value": "", "type": "query", "description": "Whether document is sale or not." }, { "name": "query", "value": "", "type": "query", "description": "Text to search." }, { "name": "copyIndicator", "value": "", "type": "query", "description": "Whether to search only copies of documents, originals or both." }, { "name": "onlycopies", "value": "", "type": "query", "description": "Whether to search only copies of documents." }, { "name": "conversationId", "value": "", "type": "query", "description": "The document conversation id used for getting its related documents." }, { "name": "totalFrom", "value": "", "type": "query", "description": "It represents the minimum value of the total range that can be used to filter documents." }, { "name": "totalTo", "value": "", "type": "query", "description": "It represents the maximum value of the total range that can be used to filter documents." }, { "name": "currency", "value": "", "type": "query", "description": "It represents the currency that can be used to filter documents only of that currency." }, { "name": "useOrOperatorForProperties", "value": "", "type": "query", "description": "It sets the property based search to meet at least one criteria within the set of provided filters." }, { "name": "page", "value": "", "type": "query", "description": "Result page to return. Each page has 'limit' number of results." }, { "name": "id", "value": "", "type": "query", "description": "The documents to get DocumentInformation for (a Tradeshift UUID value)" }, { "name": "sentBy", "value": "", "type": "query", "description": "Sender company tenant id (a Tradeshift UUID value)." }, { "name": "sentTo", "value": "", "type": "query", "description": "Receiver company tenant ids (a Tradeshift UUID value)." }, { "name": "processState", "value": "", "type": "query", "description": "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." }, { "name": "withoutProcessState", "value": "", "type": "query", "description": "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." }, { "name": "branchId", "value": "", "type": "query", "description": "Document business ids. Can be used multiple times, which is interpreted as OR." }, { "name": "totals", "value": "", "type": "query", "description": "Whether to calculate the documents total amount or not." }, { "name": "onlydrafts", "value": "", "type": "query", "description": "Whether to search only drafts." }, { "name": "onlydeleted", "value": "", "type": "query", "description": "Whether to search only deleted documents." }, { "name": "requesterId", "value": "", "type": "query", "description": "This field can be used to filter documents by the given list of requester Ids, only applicable for Purchase Request Documents. The requester is either the creating person or the document or if specified the \"on behalf of\" person\n" }, { "name": "invoiceTypeCode", "value": "", "type": "query", "description": "This field represents the type of invoice for an invoice document. If the field is missing then we will have a normal/commercial invoice filter. For value 325 proforma invoice type will be searched and for value 386 we will have prepayment invoice.\n" }, { "name": "profileId", "value": "", "type": "query", "description": "It represents the profile id of a given document." } ] }, "docs": "Gets a list of documents in CSV format 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. Could be sorted by DueDate, LastEdit, Number, Amount, Date, Type. The returned mime-type is always text/csv regardless if Accept header is application/csv or text/csv." }, { "info": { "name": "send document", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/dispatcher", "params": [ { "name": "documentId", "value": "", "type": "query", "description": "A client-generated id for the new document to be dispatched\n" }, { "name": "documentProfileId", "value": "", "type": "query", "description": "The document profile id that the document adheres to (e.g. \\\"nes.p5.invoice.ubl.2.1.dk\\\"), from the 'documentprofiles' resource\n" }, { "name": "documentSource", "value": "", "type": "query", "description": "Track the document's source - We save the source of the document in a new table called documentsource so that we know where the document was dispatched from." } ] }, "docs": "Store and dispatch the document - the actual document content must be sent as the entity/body of the POST call.\n" }, { "info": { "name": "Get Latest Dispatches", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/dispatches", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "documentId", "value": "", "type": "query", "description": "List of document UUID identifiers" }, { "name": "accept", "value": "", "type": "query", "description": "Media type for response" } ] }, "docs": "Get a list of the latest dispatch information by object IDs. The returned data contains information like:\nthe creation time of the dispatch, the dispatch sender, the channel through which the document is dispatched,\nthe current dispatch state, the ID of the object being dispatched, the connection ID used for dispatching and\ntechnical information containing the reason why a dispatch failed (returned only for failed dispatches).\n" }, { "info": { "name": "get document net amount", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/netAmount", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "documentIds", "value": "", "type": "query", "description": "The document uuid. Can be used multiple times." } ] }, "docs": "Gets a list of document net amounts for a list of document ids." }, { "info": { "name": "Receive document", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/received/:documentId", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "documentId", "value": "", "type": "path", "description": "The new document's id" } ] }, "docs": "This endpoint saves the content of a document for cases when a company has received a document outside of the\nTradeshift platform but wants to add it to the document list anyway. It imports a document as if it has been\nreceived at some point in time. It will be visible in the document list, but replies, such as comments, will\nnot be possible. Only the receiver side copy is created and the original sender will not be notified even if\nthey are on the platform and they are connected.\n" }, { "info": { "name": "validate a document", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/validate", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "documentProfileId", "value": "", "type": "query", "description": "Document profile used for validating the document." }, { "name": "receiverCompanyId", "value": "", "type": "query", "description": "The receiver company id whose document profile will be used for validation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This resource validates a given UBL document content by using a combined document profile made of the sender's default document\nprofile using documentProfileId (e.g. \"tradeshift.invoice.ubl.1.0\") and the document profile set between the sender and the receiver.\nThis can be used before dispatching a document in order to verify if it has profile related errors or not. If the \"receiverCompanyId\"\nparameter is not specified then the validation will be done using only the sender \"documentProfileId\". I" }, { "info": { "name": "find document", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/:documentId", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" }, { "name": "includeDraftAttachments", "value": "", "type": "query", "description": "Include attachements in the UBL when the document is in DRAFT state" } ] }, "docs": "Returns the document identified by the given UUID, if it exists and is not marked as deleted.\nIf you want to retrieve the deleted documents, use [Find Documents](#get-rest-external-documents) along\nwith stag=deleted parameter and with the corresponding id.\nThe document can be retrieved in a PDF representation or in one of the raw UBL formats\n(XML, JSON or Oasis JSON) depending on the Accept header. The default format is the XML.\n" }, { "info": { "name": "update document", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/:documentId", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" }, { "name": "draft", "value": "", "type": "query", "description": "Parameter that indicates if the document should be created in draft mode or not. Documents such as Order Change, Receipt Advice, Remittance Advice,\nStatus Messages, Reminder Messages or Assignments can't be created as drafts while documents such as Invoice are partially validated when it is saved as draft.\n" }, { "name": "documentProfileId", "value": "", "type": "query", "description": "The document profile id of the document which will be created (e.g. \"tradeshift.requisition.ubl.1.0\"), from the 'documentprofiles' resource." }, { "name": "schemaValidate", "value": "", "type": "query", "description": "Parameter that indicates if the document should be validated against the UBL schema. If this parameter is set to TRUE, the API will detect the UBL\nversion to validate against from the document content. This validation is triggered only if the document is *not* created as draft and also\nif the Nemhandel validation is enabled for the specified document profile.\n" }, { "name": "validateDocumentProfile", "value": "", "type": "query", "description": "Parameter that indicates if the document should be validated or not using the selected document profile.\nThe validation is triggered only if the document is not created as draft.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This resource allows to store a document within the Tradeshift platform. The actual document content is sent\nas the entity/body of the API call. The client can decide on the UUID for the new element defined by the\n\"documentId\" parameter. Saving a document as draft will use the document content as primary source for tradeshift internal\nconversion which will output a new TSUBL content overwriting the initial one. By doing so extra connection checks will occur.\nOtherwise, saving it as a non-draft w" }, { "info": { "name": "delete document", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/:documentId", "params": [ { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" } ] }, "docs": "Soft delete of the document. Deleting a document using this API will not delete the document from the\nsystem, but mark it as deleted. This operation will only affect user's copy of the document, receiver's\n(or sender's) copy will remain intact.\nUser can still query deleted documents if they wish to do so. More details about how to retrieve deleted\ndocument can be found in [Find Documents](#get-rest-external-documents) section.\nIt's not recommended to delete a document using given endpoint.\n" }, { "info": { "name": "remove document content", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/:documentId/content", "params": [ { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" } ] }, "docs": "Truncate the content for the given document if any exists. This action cannot be revoked or reverted.\nThis is to be used if document content must be permanently wiped, for example for privacy reasons. Truncated documents\nwill have all content except number and issue date removed. All versions of the document will also be truncated\nincluding the document attachments. The document will not be visible in the document manager UI.\n" }, { "info": { "name": "convert a document", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/:documentId/convert", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" }, { "name": "targetDocumentType", "value": "", "type": "query", "description": "This parameter represents the document type to convert to. It should be either (case-sensitive) 'invoice' or 'creditnote'." }, { "name": "targetDocumentTargetType", "value": "", "type": "query", "description": "This parameter represents the document profile id that the document adheres to\n(e.g. 'tradeshift.invoice.ubl.1.0'), from the 'documentprofiles' resource.\n" }, { "name": "draft", "value": "", "type": "query", "description": "Parameter that indicates if the document should be converted in draft mode or not.\n" }, { "name": "withAttachments", "value": "", "type": "query", "description": "Parameter that indicates if the converted document should contain the source document attachements or not." } ] }, "docs": "This endpoint allows the conversion of a draft document to another type, keeping the same id. Its primary purpose is\nfor when an Invoice or a CreditNote has been created as draft but with the wrong type. The only valid conversions are of\ndraft invoices to draft credit notes or vice-versa. The converted document will not be saved or dispatched. If the client requires this action,\nother endpoints can be used. More details about saving or dispatching can be found in\n[Send Document](#post-rest-exter" }, { "info": { "name": "Get First Dispatch", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/:documentId/dispatches/first", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" } ] }, "docs": "Get the first dispatch information with regards to a previously dispatched document" }, { "info": { "name": "Get Latest Dispatch", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/:documentId/dispatches/latest", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" } ] }, "docs": "Get the latest dispatch information with regards to a previously dispatched document" }, { "info": { "name": "Dispatch a saved document", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/documents/:documentId/dispatches/:dispatchId", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "dispatchId", "value": "", "type": "path", "description": "The dispatch id used for dispatching the document" }, { "name": "documentId", "value": "", "type": "path", "description": "Document UUID identifier" }, { "name": "documentSource", "value": "", "type": "query", "description": "Track the document's source - We save the source of the document in a new table called documentsource so that we know where the document was dispatched from." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Dispatch a previously saved document. The client can decide on the UUID for the new dispatch. \nIf the receiver has custom validations enabled, the document will be validated using the receivers custom document profile. \nThe body of the PUT is a connection identifier object which is not mandatory. If connectionId is not provided, the connection id will be determined from the document. \nWhen Content-Type header is text/xml, the minimal request body should be in the format ` The assignment will be visible if the company is the current branch or one of the child branches.\n" } ] }, { "info": { "name": "dx-category--assignments-create", "type": "folder" }, "items": [ { "info": { "name": "create assignment", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/assignments", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new assignment.
It must have the following mandatory JSON nodes in the request body: The list of assigneeIds, if provided, must contain at least one valid user or user group.
If no assignees are provided or all provided are missing/invalid/are not members of the current branch, the API will return an error(no default assignee logic is used).The assignees can be users or teams.
Also, for the provided assignees, auto-assignees an" } ] }, { "info": { "name": "dx-category--assignments-update", "type": "folder" }, "items": [ { "info": { "name": "update assignment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.tradeshift.com/tradeshift/rest/external/assignments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "An UUID representing the assignment id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an assignment with assignees, tags, comment, outcome. The new assignees will be added to the existing ones and the duplicates will be removed. The new tags will be added to the existing ones and the duplicates will be removed. The comment will replace the existing one. The outcome will replace the existing one.\n" }, { "info": { "name": "update assignment status to CLOSED", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/assignments/:id/close", "params": [ { "name": "id", "value": "", "type": "path", "description": "An UUID representing the assignment id." } ] }, "docs": "Update the status of the assignment to CLOSED.
The assignment can be closed if it is in OPEN state.\n" }, { "info": { "name": "update assignment comment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/assignments/:id/comment", "params": [ { "name": "id", "value": "", "type": "path", "description": "An UUID representing the assignment id." } ] }, "docs": "Update the comment of the assignment.
You should put the new comment of the assignment in the request body as plain text.\n" } ] }, { "info": { "name": "dx-category--assignments-reassign", "type": "folder" }, "items": [ { "info": { "name": "reassign assignment", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/assignments/:id/reassign/:assigneeid", "params": [ { "name": "id", "value": "", "type": "path", "description": "An UUID representing the assignment id." }, { "name": "assigneeid", "value": "", "type": "path", "description": "An UUID representing the id of the new assignee." } ] }, "docs": "Reassign the assignment with the given id to the new assignee.\n" }, { "info": { "name": "reassign user assignments", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/assignments/assignees/:from_assigneeid/reassignees/:to_assigneeid", "params": [ { "name": "from_assigneeid", "value": "", "type": "path", "description": "An UUID representing the assignee id." }, { "name": "to_assigneeid", "value": "", "type": "path", "description": "An UUID representing the reassignee id." } ] }, "docs": "Reassign the assignments of the first assignee id to the assignee with the second id.
The assignees can be users or teams.
The assignments will be updated if: \n" } ] }, { "info": { "name": "dx-category--assignments-logs", "type": "folder" }, "items": [ { "info": { "name": "get assignment logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/assignments/:id/logs", "params": [ { "name": "id", "value": "", "type": "path", "description": "An UUID representing the assignment id." } ] }, "docs": "Get an assignment by id with all its logs. The assignment will be visible if: \n" }, { "info": { "name": "get assignments by subjectid", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/assignments/subjects/:subjectId/logs", "params": [ { "name": "subjectId", "value": "", "type": "path", "description": "A string representing a subject id ( usually a document UUID )." }, { "name": "page", "value": "", "type": "query", "description": "Number representing the page to be return from the paginated result-set." }, { "name": "limit", "value": "", "type": "query", "description": "The number of assignments displayed per page." } ] }, "docs": "Get a paged list of assignments with all their logs, filtered by subject id which usually is a document id.
The assignments will be visible if: \n" } ] }, { "info": { "name": "dx-category--bsd-documents", "type": "folder" }, "items": [ { "info": { "name": "Search documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents", "params": [ { "name": "accountingSystemId", "value": "", "type": "query", "description": "Identifier of the supplier, which this document relates to, as it was used in the SMD." }, { "name": "branchId", "value": "", "type": "query", "description": "Internal identifier of the buyer branch, which this document relates to,\nas it has been configured on the platform.\n" }, { "name": "state", "value": "", "type": "query", "description": "The state of the document in Buyer Sourced Documents" }, { "name": "documentType", "value": "", "type": "query", "description": "The type of the document" }, { "name": "externalDocumentId", "value": "", "type": "query", "description": "Unique identifier to the customer. It can be a customer-generated UUID, an ERP document ID,\nor an ID from a scanning solution. The external ID must also be present in the actual UBL\nof invoices and credit notes in the file ID reference.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page of responses to get" }, { "name": "size", "value": "", "type": "query", "description": "The size of the page" }, { "name": "orderBy", "value": "", "type": "query", "description": "We currently only support ordering the documents by `created`, but that might change in the future.\nThe ordering is specified after a colon `:`. By default, we order ascending (`asc`).\n" } ] }, "docs": "Get an overview of all the documents the buyer has staged for its suppliers -\noptionally filtered to match the chosen parameters.\nSince there can be millions of documents, the results can be paginated. If the\ntotal number of rows matching the filter parameters is large, the total count\nin the result is an estimate and may deviate significantly from the actual value.\n" }, { "info": { "name": "Load document", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents", "params": [ { "name": "accountingSystemId", "value": "", "type": "query", "description": "Identifier of the supplier, which this document relates to, as it was used in the SMD." }, { "name": "branchId", "value": "", "type": "query", "description": "Internal identifier of the buyer branch, which this document relates to, as it has been configured on the\nplatform.\n" }, { "name": "documentProfileId", "value": "", "type": "query", "description": "The UBL document profile of the posted document." }, { "name": "externalDocumentId", "value": "", "type": "query", "description": "Identifier of the invoice the document relates to. I.e. if the document is an invoice, then it can be\nits own invoice number.\n" }, { "name": "documentReferenceId", "value": "", "type": "query", "description": "Identifier (externalDocumentId) of a document that current document refers to. I.e. if the document is\nan application response, then it can have a documentReferenceId that points to an invoice.\nStaging an application response without supplying a documentReferenceId is considered an error.\n" }, { "name": "sourceRef", "value": "", "type": "query", "description": "Customer reference to where the documents were sourced from.\n" } ] }, "docs": "Stage a new historical document for being loaded into a suppliers history, when they onboard." }, { "info": { "name": "Get Document Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents/:externalDocumentId", "params": [ { "name": "externalDocumentId", "value": "", "type": "path", "description": "The external identifier of the document. I.e. if the document is an invoice, then it can be its own invoice\nnumber.\n" } ] }, "docs": "Get one document's metadata\n" }, { "info": { "name": "Load/Override Document", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents/:externalDocumentId", "params": [ { "name": "externalDocumentId", "value": "", "type": "path", "description": "The external identifier of the document. I.e. if the document is an invoice, then it can be its own invoice\nnumber.\n" }, { "name": "accountingSystemId", "value": "", "type": "query", "description": "Identifier of the supplier, which this document relates to, as it was used in the SMD." }, { "name": "branchId", "value": "", "type": "query", "description": "Internal identifier of the buyer branch, which this document relates to, as it has been configured on the\nplatform.\n" }, { "name": "documentProfileId", "value": "", "type": "query", "description": "The UBL document profile of the posted document." }, { "name": "documentReferenceId", "value": "", "type": "query", "description": "Identifier (externalDocumentId) of a document that current document refers to. I.e. if the document is\nan application response, then it can have a documentReferenceId that points to an invoice.\nStaging an application response without supplying a documentReferenceId is considered an error.\n" }, { "name": "sourceRef", "value": "", "type": "query", "description": "Customer reference to where the documents were sourced from.\n" } ] }, "docs": "Stage a new historical document for being loaded into a suppliers history, when they onboard.\nAlready existing invoice or credit note with the same externalDocumentId and state IMPORTED will be archived.\n" }, { "info": { "name": "Archive Document", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents/:externalDocumentId", "params": [ { "name": "externalDocumentId", "value": "", "type": "path", "description": "The external identifier of the document. I.e. if the document is an invoice, then it can be its own invoice\nnumber.\n" } ] }, "docs": "Permanently archives the document.\n" }, { "info": { "name": "Redispatch Document", "type": "http" }, "http": { "method": "POST", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents/:externalDocumentId/redispatch", "params": [ { "name": "externalDocumentId", "value": "", "type": "path", "description": "The external identifier of the document. I.e. if the document is an invoice, then it can be its own invoice\nnumber.\n" } ] }, "docs": "Retry the dispatch of a failed document by setting its state to IMPORTED.\nThe document will the asynchronously be picked up for dispatch again.\n" }, { "info": { "name": "Get Document Content", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents/:externalDocumentId/content", "params": [ { "name": "externalDocumentId", "value": "", "type": "path", "description": "The external identifier of the document. I.e. if the document is an invoice, then it can be its own invoice\nnumber.\n" } ] }, "docs": "Retrieve document content.\n" }, { "info": { "name": "Get Document State Changes", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents/:externalDocumentId/states", "params": [ { "name": "externalDocumentId", "value": "", "type": "path", "description": "The external identifier of the document. I.e. if the document is an invoice, then it can be its own invoice\nnumber.\n" } ] }, "docs": "Retrieve information about document states changes.\n" }, { "info": { "name": "Get Document References", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/suppliermanagement/documents/:externalDocumentId/references", "params": [ { "name": "externalDocumentId", "value": "", "type": "path", "description": "The external identifier of the document. I.e. if the document is an invoice, then it can be its own invoice\nnumber.\n" } ] }, "docs": "Retrieve List Of Document References\n" } ] }, { "info": { "name": "Document Validation", "type": "folder" }, "items": [ { "info": { "name": "Validate document", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/document-validation/validation/validate-document", "params": [ { "name": "senderTenantId", "value": "", "type": "query", "description": "UUID of the user company (tenant) that is sending the document. This can be different than the 'tenantId' header value, for example when checking on behalf of a branch. The sender tenant id is used to obtain the connection properties of the connection between the receiver and sender, or other sender related settings." }, { "name": "receiverTenantId", "value": "", "type": "query", "description": "UUID of the company (tenant) that will receive the document. The receiver tenant is used to check the validators of the receiver when the receiver company has configured validation for other companies sending documents (for example 'sellers' sending invoices to a 'buyer'), to obtain the connection properties of the connection between the receiver and sender, to obtain the country compliance validator groups of the receiver if enabled, or other receiver related settings." }, { "name": "documentId", "value": "", "type": "query", "description": "Optional document id to validate, if provided the document content body is ignored." } ] }, "docs": "Validate a document by testing matching validators, optionally specifying a category to filter the validator groups that are applied. Only the validator groups for the provided document type are run." }, { "info": { "name": "Gets a validator group", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/document-validation/validation/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "UUID of the validator group to get" } ] }, "docs": "Gets a validator group definition" }, { "info": { "name": "Save validator group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tradeshift.com/tradeshift/rest/external/document-validation/validation/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "UUID of the validator group to create or update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a validator group definition" }, { "info": { "name": "Delete validator group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tradeshift.com/tradeshift/rest/external/document-validation/validation/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "UUID of the validator group to delete" } ] }, "docs": "Permanently deletes a validator group definition" }, { "info": { "name": "Get change history", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/document-validation/validation/groups/:groupId/history", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "UUID of the validator group to get" } ] }, "docs": "Gets the validator group change history, including current definition." }, { "info": { "name": "List Validator Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.tradeshift.com/tradeshift/rest/external/document-validation/validation/groups", "params": [ { "name": "senderTenantId", "value": "", "type": "query", "description": "UUID of the user company (tenant) that is sending the document. This can be different than the 'tenantId' header value, for example when checking on behalf of a branch. The sender tenant id is used to obtain the connection properties of the connection between the receiver and sender, or other sender related settings." }, { "name": "receiverTenantId", "value": "", "type": "query", "description": "UUID of the company (tenant) that will receive the document. The receiver tenant is used to check the validators of the receiver when the receiver company has configured validation for other companies sending documents (for example 'sellers' sending invoices to a 'buyer'), to obtain the connection properties of the connection between the receiver and sender, to obtain the country compliance validator groups of the receiver if enabled, or other receiver related settings." }, { "name": "documentType", "value": "", "type": "query", "description": "Optional document type filter. If not provided, validators with any document type will be returned" }, { "name": "countryComplianceCode", "value": "", "type": "query", "description": "Optional country code used to list by specific country compliance rules. If not provided, it is determined from the country of the receiver (receiverTenantId) if enabled on receiver.To list all country compliance validator groups use the special value 'ALL'.To list all the groups of the receiver but without the country compliance ones, even if defined and enabled, use the special value 'NONE'." } ] }, "docs": "List validator groups for the tenant, optionally filtering by document type or connection property" } ] } ], "bundled": true }