Yordex

Suggest Edits

REST principles

 

Our API is based on REST principles which means that our URLs are resource oriented ("Orders", "Traders") and that we use HTTP verbs such as POST, PUT and GET to distinguish between different types of actions. We use JSON in the body for all requests and responses and we use standard HTTP response codes to indicate success or failure.

You should use your API key in the "Authorization" field of the HTTP header for authorization. You should have received your API key from us. If you do not yet have your API key, please contact us.

Suggest Edits

Versioning

 

Our API will be versioned with "v1", "v2" etc. in the URL path. We won't increase version number very often and even when we do, we will still continue to support the old version for at least another year.

Within a version, our API will always be backwards compatible. There are however some changes that we will make within a version because we consider them backwards compatible:

  • Adding new API resources
  • Adding a new optional parameters or changing the order of parameters of existing resources, both for requests and responses
  • Adding new values for existing parameters, e.g. "status" fields or "reason" fields in error codes
  • Changing the length of the Yordex generated fields of existing resources, e.g. "id" fields

We will not warn you in advance when we make any of these changes, so please make sure that your code does not break when we do.

Suggest Edits

HTTP Response Codes

 

200

Generic OK response

201

OK response when a new entity is created and the id is returned, e.g. a new order or a new trader

202

Processing of the request is handled offline or later. We don't yet know if it will succeed or not.

204

OK response. No body in the response.

400

The request is malformed e.g a syntax error, or some other validations fails

401

Unauthorised. API key is not valid or the email/password is wrong

403

Forbidden. API key is valid but permissions are not right

409

Conflict. For example, when updating a Term with a name that is already taken by another term

422

Syntax is correct, but the validation fails. For example, when an email address is malformed

500

Catch all error used for any other error than the ones listed above

Our API errors all have the following structure

{
  "title":"Validation Failed",
  "status":422,
  "detail":"The content you've sent contains 1 validation errors.",
  "errors":[ 
    {
      "message":"Order amount can't be negative"
    }
  ]
}

The status is the HTTP response code. It can have the values described in the HTTP Response Codes section.

Suggest Edits

Orders Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this order

buyerOrderReference

String, optional
The reference or ID under which this order is known in the systems of the buyer. The maximum length is 256 characters

sellerOrderReference

String, optional
The reference or ID under which this order is known in the systems of the seller. The maximum length is 256 characters

status

String, Yordex generated
The status of this order. Possible values are listed on the right

buyerId

String, mandatory
The id for the trader who is the buyer in this order. This is the id used in the Traders API. This ID can also be found on the Contacts page for this trader

sellerId

String, mandatory
The id for the trader who is the seller in this order. This is the id used in the Traders API. This ID can also be found on the Contacts page for this trader

buyerCompanyTradingName

String, Yordex generated
The company trading name for the trader who is the buyer in this order. This name is inserted by us for convenience. We will obtain if from the Traders API but you can also set it directly.

sellerCompanyTradingName

String, Yordex generated
The company trading name for the trader who is the seller in this order. This name is inserted by us for convenience. We will obtain if from the Traders API but you can also set it directly.

description

String, optional
A description for this order. The maximum length for this field is 255 characters

orderAmountInCents

Number, optional when creating order, mandatory when approving order
The total value for this order expressed in cents of the orderCurrency including VAT or GST. For example, when the orderAmountInCents is 100 and the orderCurrency is USD, the order is for $1. This field is optional when creating the order but mandatory when approving the order

orderCurrency

String, optional when creating order, mandatory when approving order
The currency for this order using the ISO-4217 standard. This field is optional when creating the order but mandatory when approving the order

orderCurrencyExponent

String, Yordex generated
Indicates how many numbers at the end are reserved for cents. For most currencies this will be “2” : they have 2 digits so 100 cents. Some currencies have 0, 1 or 3 numbers. You will find a full list of supported currencies and their exponents here

vatAmountInCents

Number, Yordex generated
The amount of VAT or GST included in the order amount in cents of the orderCurrency. This field will be calculated by Yordex if tax is included in the line items.

buyerUserId

String, optional
The user id of the the employee on the buyer's side who owns this order. This field can only be set by the buyer and it is updated using a PATCH.

sellerUserId

String, optional
The user id of the the employee on the seller's side who owns this order. This field can only be set by the seller and it is updated using a PATCH.

buyerStatus

String, optional
The status of this order in the buyer's systems. This field can only be set by the buyer and it is updated using a PATCH.

sellerStatus

String, optional
The status of this order in the seller's systems. This field can only be set by the seller and it is updated using a PATCH.

buyerTags

Array, optional
A set of user defined key:value pairs that can be used by the buyer to label the order. This field can only be set by the buyer and it is updated using a PATCH.

sellerTags

Array, optional
A set of user defined key:value pairs that can be used by the seller to label the order. This field can only be set by the seller and it is updated using a PATCH.

creationDate

String, Yordex generated
The date on which this order was created using the ISO-8601 standard

modificationDate

String, Yordex generated
The date on which this order was last updated using the ISO-8601 standard

terms

String, optional
The name of the terms to be used for this order. See the Terms API

events

Array, optional when creating order, mandatory when approving order
An array representing the terms for this order. Every event represents a real-world event that can trigger a payment, e.g. “contract signed”, “goods ready for shipping” or “goods received”. The structure of an event is described in the Events API section. The events array is optional when creating the order but mandatory when approving the order

buyerCostAllocation

Array, optional
An array of budget(s) that this order should be charged to for the buyer. When the order has no line items, this field can be set directly. When the order has line items, this field will be populated by the system as the weighted average of all cost allocations of the line items.

sellerCostAllocation

Array, optional
An array of budget(s) that this order should be charged to for the seller. When the order has no line items, this field can be set directly. When the order has line items, this field will be populated by the system as the weighted average of all cost allocations of the line items.

. budget

Object, mandatory when a buyerCostAllocation is provided
The budget that this order is assigned to. Fields used here are customised to your cost centre hierarchy.

. allocation

Object, mandatory when a buyerCostAllocation is provided
The % of the order that is assigned to this budget.

. budgetName

String, Yordex generated
The name of the budget to be used for display and reporting purposes only

services

String, optional
The services used in this order.

. serviceName

String, mandatory for each service
Name of the service

. tags

Array, optional
Array of key:value pairs. Both the key and the value can be set by the user. A maximum of 5 tags can be added for each service.

approvals

Array, Yordex generated
All approvals received for this order

. approved

Boolean, mandatory
Indicating approval (true) or rejection (false) of this order

. date

String, Yordex generated
The date on which this order was approved using the ISO-8601 standard

. approverTraderId

String, Yordex generated
Id of the trader who approved the order

. approver

String, Yordex generated
Role of the party that approved. This can be SELLER, BUYER or SYSTEM

Order status
Description

NOT_APPROVED

Order is not yet approved and can still be edited

TRADER_APPROVED

Both buyer and seller approved the order but Yordex is still reviewing it

APPROVED

Order is approved and the events are in progress

COMPLETED

Order is completed, all events and all payments have been completed

CLOSED

Order was cancelled by the seller. The order can be re-opened using the “Open order” method

Suggest Edits

Create order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders
curl https://api.yordex.com/v1/orders  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{ 
  "buyerId" : "buyer-id",
  "sellerId" : "seller-id",
  "buyerOrderReference": "PO number",
  "description": "My order",
  "orderAmountInCents": 100000,
  "orderCurrency": "USD",
  "buyerUserId": "user-id",
  "buyerTags": [
    "orderType": "PO"
    "poType": "STOCK"
  ],
  "terms": "30% upfront 70% before shipping"
}'
// Set up the order
Order newOrder = Order.builder().
  buyerId("buyerId").
  sellerId("sellerId").
  orderCurrency("GBP").
  orderAmountInCents(12222).
  terms("30% upfront 70% before shipping").
  build();

// Set up the API keys
RequestOptions requestOptions = RequestOptions.builder().
  apiKey("buyerApiKey").
  build();

// Create the order
try {
	newOrder = Order.createAndApproveOrder(newOrder, buyerApiKey, sellerApiKey, requestOptions );
} catch(YordexException ex) {
	// Handle the error
}

// Get the order ID and store it in your database
newOrderId = newOrder.getId();
A binary file was returned

You couldn't be authenticated

{ 
  "id" : "order-id",
  "buyerOrderReference": "PO number",
  "buyerId" : "buyer-id",
  "buyerCompanyTradingName": "Buyer Name",
  "sellerId" : "seller-id",
  "sellerCompanyTradingName": "Seller Name",
  "description": "My order",
  "orderAmountInCents": 100000,
  "orderCurrency": "USD",
  "orderCurrencyExponent": 2,
  "buyerUserId": "user-id",
  "buyerTags": [
    "orderType": "PO"
    "poType": "STOCK"
  ],
  "status": "NOT_APPROVED",
  "nextApprover": "seller-id",
  "vatAmountInCents": 20000,
  "creationDate": "2016-11-21",
  "modificationDate": "2016-11-21",
  "events": [
    {
      "id": "event-id-1",
      "pctToBePaid": 30,
      "eventName": "Order approved",
      "paymentName": "Deposit",
      "eventNumber": 1,
      "amountToBePaidInCents": 30000,
      "status": "NOT_STARTED",
      "confirmed": false,
      "creditTerms": 14
    },
    {
      "id": "event-id-2",
      "pctToBePaid": 70,
      "eventName": "Goods shipped",
      "paymentName": "Final payment",
      "eventNumber": 2,
      "amountToBePaidInCents": 70000,
      "status": "NOT_STARTED",
      "documentsRequired": [ "Bill of lading" ],
      "confirmers": [ "BUYER" ],
      "confirmed": false,
      "creditTerms": 15,
      "creditTermsFrom": "EOM"
    }
  ]
}

Body Params

buyerId
string
required
sellerId
string
required
buyerOrderReference
string
sellerOrderReference
string
description
string
orderAmountInCents
string
orderCurrency
string
buyerUserId
string
buyerTags
array
terms
string

Headers

Authorization
string
Content-Type
string
 

Here is a tutorial on how to create an order

Suggest Edits

Update order

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.yordex.com/v1/orders/orderId
curl https://api.yordex.com/v1/orders/order-id  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PUT  
-d '{ 
  "buyerOrderReference": "buyer-reference",
  "sellerOrderReference": "seller-reference",
  "description": "My order",
  "orderAmountInCents": 100000,
  "orderCurrency": "USD",
  "buyerUserId": "user-id",
  "buyerTags": [
    "orderType": "PO"
    "poType": "STOCK"
  ],
  "terms": "30% upfront 70% before shipping",
  "buyerCostAllocation": [
    {
      "budget": {
        "department": "Marketing",
        "costCentre": "Marketing,4890"
      },
      "allocation": 100
    }
  ]  
}'
Order updatedOrder = Order.builder().
        orderCurrency("GBP").
        orderAmountInCents(12222).
        buyerOrderReference("buyerReference").
        sellerOrderReference("sellerOrderReference").
        description("First Order").
        terms("30% upfront 70% before shipping").
        build();
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
updatedOrder = Order.update(updatedOrder, requestOptions);
A binary file was returned

You couldn't be authenticated

{ 
  "id" : "order-id",
  "buyerOrderReference": "buyer-reference",
  "sellerOrderReference": "seller-reference",
  "buyerId" : "buyer-id",
  "buyerCompanyTradingName": "Buyer Name",
  "sellerId" : "seller-id",
  "sellerCompanyTradingName": "Seller Name",
  "description": "My order",
  "orderAmountInCents": 100000,
  "orderCurrency": "USD",
  "orderCurrencyExponent": 2,
  "buyerUserId": "user-id",
  "buyerTags": [
    "orderType": "PO"
    "poType": "STOCK"
  ],
  "status": "NOT_APPROVED",
  "nextApprover": "seller-id",
  "vatAmountInCents": 20000,
  "vatIncluded": true,
  "creationDate": "2016-11-21",
  "modificationDate": "2016-11-25",
  "events": [
    {
      "id": "event-id-1",
      "pctToBePaid": 30,
      "eventName": "Order approved",
      "paymentName": "Deposit",
      "eventNumber": 1,
      "amountToBePaidInCents": 30000,
      "status": "NOT_STARTED",
      "confirmed": false,
      "creditTerms": 14
    },
    {
      "id": "event-id-2",
      "pctToBePaid": 70,
      "eventName": "Goods shipped",
      "paymentName": "Final payment",
      "eventNumber": 2,
      "amountToBePaidInCents": 70000,
      "status": "NOT_STARTED",
      "documentsRequired": [ "Bill of lading" ],
      "confirmers": [ "BUYER" ],
      "confirmed": false,
      "creditTerms": 15,
      "creditTermsFrom": "EOM"
    }
  ]
}

Path Params

orderId
string
required

Body Params

buyerOrderReference
string
sellerOrderReference
string
description
string
orderAmountInCents
string
orderCurrency
string
buyerUserId
string
buyerTags
array of objects
accountingCode
terms
string

Headers

Authorization
string
Content-Type
string
 

Here is a tutorial to update an order

Suggest Edits

Update userId

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.yordex.com/v1/orders/order-id/buyerUserId
curl https://api.yordex.com/v1/orders/order-id/buyerUserId
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PATCH  
-d '{ 
  "buyerUserId": "user-id"
}'

OR

curl https://api.yordex.com/v1/orders/order-id/sellerUserId
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PATCH  
-d '{ 
  "sellerUserId": "user-id"
}'
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Approval approval = Approval.builder().approved(true).comment("My comments").build();
approval = Order.markApproval(orderId, approval, requestOptions)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

order-id
string
required

Body Params

userId
string

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Update cost allocation

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.yordex.com/v1/orders/order-id/buyerCostAllocation
curl https://api.yordex.com/v1/orders/order-id/buyerCostAllocation
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PATCH  
-d '{ 
  "buyerCostAllocation" : [
    {
      "budget" : "Department,Cost Code",
      "allocation" : 100
    }
  ]
}
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Approval approval = Approval.builder().approved(true).comment("My comments").build();
approval = Order.markApproval(orderId, approval, requestOptions)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

order-id
string
required

Body Params

budget
string
allocation
int32

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Update tags

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.yordex.com/v1/orders/order-id/buyerTags
curl https://api.yordex.com/v1/orders/order-id/buyerTags
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PATCH  
-d '{ 
    "orderType": "PO"
}'

OR

curl https://api.yordex.com/v1/orders/order-id/sellerTags
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PATCH  
-d '{ 
    "salesType": "GOLD"
}'
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Approval approval = Approval.builder().approved(true).comment("My comments").build();
approval = Order.markApproval(orderId, approval, requestOptions)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

order-id
string
required

Body Params

name1
string

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Amend order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/order-id/amend
curl https://api.yordex.com/v1/orders/order-id/amend
-H "Authorization:your-api-key"  
-X POST
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Approval approval = Approval.builder().approved(true).comment("My comments").build();
approval = Order.markApproval(orderId, approval, requestOptions)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

order-id
string
required

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Get order

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/orders/orderId
curl https://api.yordex.com/v1/orders/order-id
-H "Authorization:your-api-key"  
-X GET 
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Order order = Order.get(orderId, requestOptions);
A binary file was returned

You couldn't be authenticated

{ 
  "id" : "order-id",
  "buyerOrderReference": "buyer-reference",
  "sellerOrderReference": "seller-reference",
  "buyerId" : "buyer-id",
  "buyerCompanyTradingName": "Buyer Name",
  "sellerId" : "seller-id",
  "sellerCompanyTradingName": "Seller Name",
  "description": "My order",
  "orderAmountInCents": 100000,
  "orderCurrency": "USD",
  "orderCurrencyExponent": 2,
  "vatAmountInCents": 20000,
  "vatIncluded": true,
  "buyerUserId": "user-id",
  "buyerTags": [
    "orderType": "PO"
    "poType": "STOCK"
  ],
  "status": "APPROVED",
  "creationDate": "2016-11-21",
  "modificationDate": "2017-01-20",
  "buyerCostAllocation": [
    {
      "budget": {
        "department": "Marketing",
        "costCentre": "Marketing,4890"
      },
      "allocation": 100
    }
  ],  
  "services": [
     {
        "serviceName": "PROVIDER",
        "tags": {
           "buyerCurrency": "EUR"
        }
     }
  ],  
  "approvals": [
     {
        "approved": true,
        "date": "2016-11-29T08:34:16Z",
        "approver": "SYSTEM"
     },
     {
        "approved": true,
        "date": "2016-11-28T17:28:53Z",
        "approver": "BUYER"
     },
     {
        "approved": true,
        "date": "2016-11-28T13:50:12Z",
        "approver": "SELLER"
     }
  ],
  "events": [
    {
      "id": "event-id-1",
      "pctToBePaid": 30,
      "eventName": "Order approved",
      "paymentName": "Deposit",
      "eventNumber": 1,
      "amountToBePaidInCents": 30000,
      "receivedAmountInCents": 30000,
      "status": "COMPLETED",
      "confirmed": true,
      "creditTerms": 14,
      "invoiceDate": "2016-12-29",
      "invoiceReference": "INV-001",
      "paymentDueDate": "2016-12-13"
    },
    {
      "id": "event-id-2",
      "pctToBePaid": 70,
      "eventName": "Goods shipped",
      "paymentName": "Final payment",
      "eventNumber": 2,
      "amountToBePaidInCents": 70000,
      "status": "PAYMENT_DUE",
      "documentsRequired": [ "Bill of lading" ],
      "confirmers": [ "BUYER" ],
      "confirmed": true,
      "confirmations": [
         {
            "date": "2017-01-20",
            "confirmerTraderId": "buyer-id"
         }
      ],
      "invoiceDate": "2017-01-15",
      "invoiceReference": "INV-001",
      "creditTerms": 15,
      "creditTermsFrom": "EOM",
      "paymentDueDate": "2017-02-15",
      "earlyPaymentDiscount" : { 
        "discountPct":2.01, 
        "expiryDays":10,
        "expiryDate":"2017-01-25"
      }
    }
  ]
}

Path Params

orderId
string
required

Headers

Authorization
string
 
Suggest Edits

Get all orders

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/orders
curl https://api.yordex.com/v1/orders?q=abc
-H "Authorization:your-api-key"  
-X GET 
A binary file was returned

You couldn't be authenticated

{
  "links": [
    {
      "rel": "self",
      "href": "http://api.yordex.com/orders"
    }
  ],
  "content": [
    { 
      "id" : "order-id",
      "buyerOrderReference": "buyer-reference",
      "sellerOrderReference": "seller-reference",
      "buyerId" : "buyer-id",
      "buyerCompanyTradingName": "Buyer Name",
      "sellerId" : "seller-id",
      "sellerCompanyTradingName": "Seller Name",
      "description": "My order",
      "orderAmountInCents": 100000,
      "orderCurrency": "USD",
      "orderCurrencyExponent": 2,
      "vatAmountInCents": 20000,
      "vatIncluded": true,
      "status": "APPROVED",
      "buyerUserId": "user-id",
      "buyerTags": [
        "orderType": "PO"
        "poType": "STOCK"
      ],
      "creationDate": "2016-11-21",
      "modificationDate": "2017-01-20",
      "buyerCostAllocation": [
        {
          "budget": {
            "department": "Marketing",
            "costCentre": "Marketing,4890"
          },
          "allocation": 100
        }
      ],  
      "services": [
         {
            "serviceName": "PROVIDER",
            "tags": {
               "buyerCurrency": "EUR"
            }
         }
      ],  
      "approvals": [
         {
            "approved": true,
            "date": "2016-11-29T08:34:16Z",
            "approver": "SYSTEM"
         },
         {
            "approved": true,
            "date": "2016-11-28T17:28:53Z",
            "approver": "BUYER"
         },
         {
            "approved": true,
            "date": "2016-11-28T13:50:12Z",
            "approver": "SELLER"
         }
      ],
      "events": [
        {
          "id": "event-id-1",
          "pctToBePaid": 30,
          "eventName": "Order approved",
          "paymentName": "Deposit",
          "eventNumber": 1,
          "amountToBePaidInCents": 30000,
          "receivedAmountInCents": 30000,
          "status": "COMPLETED",
          "confirmed": true,
          "creditTerms": 14,
          "invoiceDate": "2016-12-29",
          "invoiceReference": "INV-001",
          "paymentDueDate": "2016-12-13"
        },
        {
          "id": "event-id-2",
          "pctToBePaid": 70,
          "eventName": "Goods shipped",
          "paymentName": "Final payment",
          "eventNumber": 2,
          "amountToBePaidInCents": 70000,
          "status": "PAYMENT_DUE",
          "documentsRequired": [ "Bill of lading" ],
          "confirmers": [ "BUYER" ],
          "confirmed": true,
          "confirmations": [
             {
                "date": "2017-01-20",
                "confirmerTraderId": "buyer-id"
             }
          ],
          "invoiceDate": "2017-01-15",
          "invoiceReference": "INV-001",
          "creditTerms": 15,
          "creditTermsFrom": "EOM",
          "paymentDueDate": "2017-02-15",
          "earlyPaymentDiscount" : { 
            "discountPct":2.01, 
            "expiryDays":10,
            "expiryDate":"2017-01-25"
          }
        }
      ]
    }
  ],
  "page": {
    "size": 10,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

Query Params

page
int32
size
int32
sort
string
orderStatus
string
eventStatus
string
buyerUserId
string
buyerTagValues
string
q
string

Headers

Authorization
string
 
Suggest Edits

Add service to order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/orderId/services?service=PROVIDER&tagName=tagValue
curl https://api.yordex.com/v1/orders/order-id/services?service=PROVIDER&tagName=tagValue 
-H "Authorization:your-api-key"  
-X POST
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
string
required

Query Params

service
string
required
tagName
string

Headers

Authorization
string
 
Suggest Edits

Delete service from order

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.yordex.com/v1/orders/orderId/services?service=PROVIDER
curl https://api.yordex.com/v1/orders/order-id/services?service=PROVIDER 
-H "Authorization:your-api-key"  
-X DELETE
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
string
required

Query Params

service
string
required

Headers

Authorization
string
 
Suggest Edits

Approve order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/order-id/approvals
curl https://api.yordex.com/v1/orders/order-id/approvals 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{ 
{
    "approved":true,
    "comment":"your-comment"
}'
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Approval approval = Approval.builder().approved(true).comment("My comments").build();
approval = Order.markApproval(orderId, approval, requestOptions)
A binary file was returned

You couldn't be authenticated

{
    "approverTraderId":"your-trader-id",
    "approved":true,
    "date":"2016-11-28T13:50:12Z",
    "comment":"your-comment"
}'

Path Params

order-id
string
required

Body Params

approved
boolean
required
comment
string

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Close order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/orderId/close
curl https://api.yordex.com/v1/orders/order-id/close 
-H "Authorization:your-api-key"  
-X POST
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
string
required

Headers

Authorization
string
 
Suggest Edits

Open order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/orderId/open
curl https://api.yordex.com/v1/orders/order-id/open
-H "Authorization:your-api-key"  
-X POST
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
string
required

Headers

Authorization
string
 
Suggest Edits

Update your status

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.yordex.com/v1/orders/order-id/buyerStatus
curl https://api.yordex.com/v1/orders/order-id/buyerStatus
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PATCH  
-d '{ 
	"buyerStatus":"PROCESSED"
}

OR

curl https://api.yordex.com/v1/orders/order-id/sellerStatus
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PATCH  
-d '{ 
	"sellerStatus":"PROCESSED"
}
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Approval approval = Approval.builder().approved(true).comment("My comments").build();
approval = Order.markApproval(orderId, approval, requestOptions)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

order-id
string
required

Body Params

buyerStatus
string

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Events Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this event

eventName

String, mandatory
The name of the real-world event. When this event has a payment associated with it, this will be the event that triggers the payment, e.g. "Order approved", "Goods ready for shipping" or "Goods received"

paymentName

String, optional
The name of the payment for this event. For example, this could be "Deposit", "Partial payment" or "Full payment"

status

String, Yordex generated
The status of this event. Possible values are listed on the right

pctToBePaid

String, optional
The percentage of the orderAmountInCents of the order that will be due for this event. For example, if 30% is due when the order is approved, the value for this field will be 30. The sum of pctToBePaid for all events has to be 100 but for an individual event this field can be 0 or not provided

paymentType

String, optional
The type of payment for this event. Possible values are listed on the right. This field is mandatory if pctToBePaid is defined.

amountToBePaidInCents

String, Yordex generated
This is pctToBePaid times the orderAmountInCents of the order. The currency is the same as the orderCurrency for the order.

receivedAmountInCents

String, Yordex generated
The amount that has been paid in for this order. The currency is the same as the orderCurrency for the order.

invoiceDate

String, Yordex generated
The data of the invoice. The user specifies this field when uploading the invoice as a document and we will copy that field into this event

invoiceReference

String, Yordex generated
The reference of the invoice. The user specifies this field when uploading the invoice as a document and we will copy that field into this event

confirmationDueDate

String, optional
Date by when we expect this event to be confirmed. This is used to alert responsible users when the event isn't confirmed on time and also to estimate the paymentDueDate. When the order is created the paymentDueDate is estimated to be the confirmationDueDate plus the credit terms.

paymentDueDate

String, optional
Date by which the buyer has to pay. When this date passes, the status of the event will automatically update from PAYMENT_DUE to PAYMENT_OVERDUE. It is possible to specify this date yourself, but if one or both of creditTerms or creditTermsFrom are set, the paymentDueDate will be overwritten based on the confirmationDueDate or invoiceDate.

recognitionMonths

Number, optional
The number of months over which the costs for this event has to be recognised for accounting purposes. This field is used to calculate the paymentRecognitionDates

paymentRecognitionDates

Array, Yordex generated
Date on which the costs for this event should be recognised for accounting purposes. This is based on the recognitionMonths field and the paymentDueDate.

creditTerms

String, optional
Number of days that the buyer has to pay the invoice after the event is confirmed. For example, if the value for this field is 30 that means the buyer has 30 days to pay the invoice. The paymentDueDate will be set to be the confirmation date plus creditTerms when the event is confirmed. creditTerms has precedence, over the paymentDueDate so when both paymentDueDate and creditTerms have been set before the event is confirmed, the paymentDueDate will be overwritten when the event is confirmed.

creditTermsFrom

String, optional
The start date for the creditTerms. The only possible value is EOM (End of Month). The default is the invoiceDate, but if EOM is specified, the creditTerms will start counting from the last date of the month of the invoice date.

eventNumber

String, optional for POST, mandatory for PUT
Events are sequential and the eventNumber indicates the position of this event in the list of events. The first event has eventNumber 1 etc. If no eventNumber is specified when creating an event, it will automatically be added as the last event. It is mandatory to provide an eventNumber when updating an event

documentsRequired

Array, optional
Documents that need to be uploaded before this event can be confirmed. An invoice would be a typical example of such a document, but other document types could include a bill of lading, an inspection report etc. It is up to the confirmers to verify these documents before confirming. The system will allow confirmation if the documents are not uploaded. The structure of a required document is described below.

earlyPaymentDiscount

Object, optional
An early payment discount associated with this event.

. discountPct

Float, mandatory when an earlyPaymentDiscount is set
The percentage discount offered, e.g. 2%

. expiryDays

Integer, optional
The number of days after the invoice date after which the early payment discount expires. This field is not required for [dynamic discounting[(https://yordex.com/faqs/what-is-dynamic-discounting) when the early payment discount is added after the invoice is already provided.

. expiryDate

Date, mandatory once the event is confirmed
The date on which the early payment discount will expire.

confirmers

Array, optional
Possible values are BUYER, SELLER or PROVIDER of a service. Each party listed has to confirm this event before the payment becomes due. If there are no confirmers, the payment will automatically become due as soon as the previous event is completed or as soon as the order is approved in case this is the first event of the order

confirmed

Boolean, Yordex generated
Indicates whether this event has been confirmed or not

confirmations

Array, Yordex generated
An array with all confirmations received for this event. The structure of a confirmation is described below

. confirmerType

String, Yordex generated
Actor who confirmed the event. This can be BUYER, SELLER or PROVIDER of a service

. date

String, Yordex generated
The date on which this event was confirmed using the ISO-8601 standard

invoiceMandatory

Boolean, optional
Indicates whether an invoice is mandatory for this event. If so, if the event has been fully paid, the status will become WAITING_FOR_INVOICE. Only when the invoice is provided will the status of the event become COMPLETED. The default value is false.

generateInvoice

Boolean, optional
Indicates whether an invoice should be generated by Yordex for this event. The default is false

Event Status
Description

NOT_STARTED

Event was not yet started, either because the order was not yet approved or because the previous event was not yet completed

FOR_CONFIRMATION

Event has started and the next step is for the confirmers of this event to confirm the associated real-world event has happened

PAYMENT_DUE

Real-world event has been confirmed; the payment is now due

PAYMENT_OVERDUE

Real-world event has been confirmed; the paymentDueDate has passed so the payment is now overdue

WAITING_FOR_INVOICE

The event has been confirmed and paid but the invoice has not yet been provided. An event will only go into this state if the field invoiceMandatory has been set to true

COMPLETED

Event has been confirmed and paid

Payment Type
Description

PAYMENT

Payments where the buyer pays the seller directly

PAYIN

Payments where the buyer pays a third party

PAYOUT

Payments where a third party pays the seller

Suggest Edits

Add event to order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/orderId/events
curl https://api.yordex.com/v1/orders/order-id/events 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{ 
    "eventName": "Order approved",
    "paymentName": "Deposit",
    "pctToBePaid": 30,
    "paymentType": "PAYMENT",
    "confirmationDueDate": "2018-12-01",
    "paymentDueDate": "2018-12-15",
    "creditTerms": 14,
    "creditTermsFrom": "EOM",
    "confirmers": ["BUYER","SELLER"],
    "documentsRequired": ["bill of lading"],
    "earlyPaymentDiscount" : { 
      "discountPct":2.01, 
      "expiryDays":10
    },
    "eventNumber": 1,
    "recognitionMonths": 1,
    "invoiceMandatory": true,
    "generateInvoice": false
}'
A binary file was returned

You couldn't be authenticated

{
  "id": "order-id",
  "eventName": "Order approved",
  "paymentName": "Deposit",
  "pctToBePaid": 30,
  "paymentType": "PAYMENT",
  "confirmationDueDate": "2018-12-01",
  "paymentDueDate": "2018-12-15",
  "creditTerms": 14,
  "creditTermsFrom": "EOM",
  "confirmers": ["BUYER","SELLER"],
  "documentsRequired": ["bill of lading"],
  "earlyPaymentDiscount" : { 
    "discountPct":2.01, 
    "expiryDays":10
  },
  "eventNumber": 1,
  "recognitionMonths": 1,
  "paymentRecognitionDates": [
     "2018-12-15"  
  ],
  "invoiceMandatory": true,
  "status": "NOT_STARTED",
  "confirmed": false
}

Path Params

orderId
string
required

Body Params

eventName
string
required
paymentName
string
pctToBePaid
int32
required
paymentType
string
confirmationDueDate
date
paymentDueDate
date
creditTerms
int32
creditTermsFrom
string
confirmers
array of strings
documentsRequired
array of strings
earlyPaymentDiscount
object
 
recognitionMonths
int32
eventNumber
int32
invoiceMandatory
boolean
generateInvoice
boolean

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Update event

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.yordex.com/v1/orders/orderId/events/eventId
curl https://api.yordex.com/v1/orders/order-id/events/event-id 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PUT  
-d '{ 
    "eventName": "Order approved",
    "paymentName": "Deposit",
    "pctToBePaid": 30,
    "paymentType": "PAYMENT",
    "paymentDueDate": "2016-12-15",
    "creditTerms": 14,
    "creditTermsFrom": "EOM",
    "confirmers": ["BUYER","SELLER"],
    "documentsRequired": ["bill of lading"],
    "earlyPaymentDiscount" : { 
      "discountPct":2.01, 
      "expiryDays":10
    },
    "eventNumber": 1,
    "invoiceMandatory": true
}'
A binary file was returned

You couldn't be authenticated

{
  "id": "order-id",
  "eventName": "Order approved",
  "paymentName": "Deposit",
  "pctToBePaid": 30,
  "paymentType": "PAYMENT",
  "paymentDueDate": "2016-12-15",
  "creditTerms": 14,
  "creditTermsFrom": "EOM",
  "confirmers": ["BUYER","SELLER"],
  "documentsRequired": ["bill of lading"],
  "earlyPaymentDiscount" : { 
    "discountPct":2.01, 
    "expiryDays":10
  },
  "eventNumber": 1,
  "invoiceMandatory": true,
  "status": "NOT_STARTED",
  "confirmed": false
}

Path Params

orderId
string
required
eventId
string
required

Body Params

eventName
string
required
paymentName
string
pctToBePaid
int32
required
paymentType
string
paymentDueDate
date
creditTerms
int32
creditTermsFrom
string
confirmers
array of strings
documentsRequired
array of strings
earlyPaymentDiscount
object
 
earlyPaymentDiscount.discountPct
float
earlyPaymentDiscount.expiryDays
integer
eventNumber
int32
required
invoiceMandatory
boolean

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Delete event

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.yordex.com/v1/orders/orderId/events/eventId
curl https://api.yordex.com/v1/orders/order-id/events/event-id 
-H "Authorization:your-api-key"  
-X DELETE  
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
string
required
eventId
string
required

Headers

Authorization
string
 
Suggest Edits

Confirm event

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/orderId/events/eventId/confirmations
curl https://api.yordex.com/v1/orders/order-id/events/event-id/confirmations 
-H "Authorization:your-api-key"  
-X POST  
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
EventConfirmation eventConfirmation = Event.confirm(eventId, orderId, requestOptions)
A binary file was returned

You couldn't be authenticated

{
  "date": "2016-12-12",
  "confirmerTraderId": "your-trader-id"
}

Path Params

orderId
string
required
eventId
string
required

Headers

Authorization
string
 
Suggest Edits

Traders Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this trader

traderStatus

String, Yordex generated
The registration status for this trader. See possible values on the right hand side.

partnerId

String, optional
id of the partner that created this trader. If this field is not set, the trader registered directly with Yordex

traderId

String, optional
id of the trader A that created this trader B. Specifying this field will allow trader A to edit the details of trader B. As soon as trader B creates their own account on Yordex, they will start maintaining their own trader details.

user

Object, mandatory
The details of the first user for this trader. This field is only used for the request body when creating a trader. It is not returned in the response.

. email

String, mandatory
The email address of the first user for this trader

companyTradingName

String, optional
The company trading name for this trader. This field is optional when creating the trader but mandatory when approving the first order for this trader

traderSlug

String, optional
Every trader has their own order form which is accessible to any buyer, even if that buyer does not have their own Yordex account. The URL of that page is: https://yordex.com/get-quote/traderSlug. The trader slug can only contain alphanumeric characters.

companyRegisteredName

String, optional
The official name by which this company is registered. If this name is not provided, it is assumed that this is the same as the companyTradingName

companyType

String, optional
The official company type. See here for an explanation of possible company types

registrationNumber

String, optional
The official company registration number. See here for an explanation of possible registration numbers

vatNumber

String, optional
The company VAT number

website

String, optional
URL of the company’s main website

companyTradingAddress

String, optional
Company’s main trading address. When provided, only the countryCode is mandatory

companyRegisteredAddress

String, optional
The official address where this company is based. If this address is not provided, it is assumed that this is the same as the companyTradingAddress

relevantIndividuals

Array, optional
As part of our regulatory requirements, we have to identify key individuals, including beneficial owners holding more than a 25% share in the company and company directors. You will find more more information about this process here. All these individuals should be reported in this array.

. role

String, mandatory for each relevantIndividual
The relation this individual has to the company. Possible values are “OWNER”, “DIRECTOR” and "BUSINESS_CONTACT"

. name

String, mandatory for each relevantIndividual
The person’s official full name

. dateOfBirth

String, optional
The person’s date of birth using the ISO-8601 standard

. address

Object, optional
The person’s home address

. email

Object, optional
The person’s email address

. phone

Object, optional
The person’s phone number without spaces

. pctOwnership

String, optional
The percentage of shares of the trader this person owns. If the person owns 30%, the value for this field should be 30. This field only needs to be provided when the role of this person is “OWNER”

bankAccount

Object, optional
The trader’s company bank account

. accountHolderName

String, mandatory when bankAccount is provided
Name of the account holder

. iban, accountNumber, accountType, bankCode, bic, branchCode, bsbCode, ifscCode, institutionNumber, routingNumber, sortCode, swiftCode, taxRegistrationNumber, transitNumber

String, optional
See table on the right which which fields are used for which countries.

. bankName

String, optional
Name of the bank.

. address

Object, optional
Address of the bank.

Trader Status
Description

REGISTERED

This trader has not yet confirmed their email address which means that either they did not yet click the confirmation link or their account was created by someone else.

CONFIRMED

At least one of the users of this trader has confirmed their email address. Only the trader themselves can make updates to their account details

Bank account fields
ISO country code

iban

AE, AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GE, GR, HU, IE, IT, LT, LU, LV, MT, NL, NO, PK, PL, PT, RO, SE, SI, SK

accountNumber, sortCode

GB

accountNumber, accountType, routingNumber

US

iban, bic

CH, TR

accountNumber

NZ, UA

accountNumber, bankCode

HK, ID, KR, MA, PH, RU, TH

accountNumber, bsbCode

AU

accountNumber, ifscCode

IN

accountNumber, swiftCode

MY, VN, ZA

accountNumber, bankCode, branchCode

BD, LK, SG

accountNumber, bankCode, taxRegistrationNumber

MX

accountNumber, accountType, bankCode, branchCode

JP

accountNumber, accountType, institutionNumber, transitNumber

CA

accountNumber, accountType, bankCode, branchCode, taxRegistrationNumber

BR

accountNumber, BIC

All other countries

Suggest Edits

Create trader

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/traders
curl https://api.yordex.com/v1/traders  
-H "Content-type: application/json"  
-H "Accept: application/json"  
-X POST  
-d '{ 
    "partnerId":"your-partner-id",
    "traderId":"your-trader-id",
    "user" :{
      "email":"user@mycompany.com"
    },
    "companyTradingName": "Company name",
    "traderSlug": "company-name",
    "companyRegisteredName": "Official company name",
    "companyType": "Limited Liability Company",
    "registrationNumber": "12345678",
    "vatNumber": "12345678",
    "website": "http://mycompany.com",
    "companyTradingAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "companyRegisteredAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "relevantIndividuals": [
      {
        "role": "OWNER",
        "name": "Fred G. Stringer",
        "dateOfBirth": "1972-06-08",
        "address": {
          "address1": "Address line 1",
          "address2": " Address line 2",
          "address3": " Address line 3",
          "postalCode": "12345",
          "city": "City",
          "state": "CA",
          "countryCode": "US"
        },
        "pctOwnership": 30
      }
    ],
    "bankAccount": {
      "bankName": "Wells Fargo",
      "accountHolderName": "Company name",
      "accountNumber": "12345678",
      "sortCode": "01-01-01",
      "IBAN": "ES35 6743 7823 4567 8901",
      "routingNumber": "123456"
    }
}'
// Set up a user
User newUser = User.builder().
  email("user@tradercompany.com").
  build();
RelevantIndividual newRelevantIndividual = RelevantIndividual.builder().
  role("BUSINESS_CONTACT").
  firstName("John").
  lastName("Doe").
  email("user@tradercompany.com").
  phone("+12123456789").
  build();
Set<RelevantIndividual> relevantIndividuals = new HashSet<>();
relevantIndividuals.add(newRelevantIndividual);

// Set up the trader company address
Address newTradingAddress = Address.builder().
  address1("1001 Fifth Avenue").
  city("New York").
  postalCode("10010").
  state("NY").
  countryCode("US").
  build();

// Create the trader
Trader newTrader = Trader.builder().
  partnerId("partner-id").
  user(newUser).
  companyTradingName("Trader company name").
  companyTradingAddress(newTradingAddress).
  website("https://www.tradercompany.com").
  relevantIndividuals(relevantIndividuals).
  build();

try { 
  newTrader = Trader.create(newTrader);
} catch (YordexException ex) {
  // Handle the error
}

// Get the traderId and store it safely in your database
traderId = newTrader.getId(); 
A binary file was returned

You couldn't be authenticated

{ 
    "id": "trader-id",
    "partnerId": "your-partner-id",
    "traderId": "your-trader-id",
    "companyTradingName": "Company name",
    "traderSlug": "companyname",
    "companyRegisteredName": "Official company name",
    "companyType": "Limited Liability Company",
    "registrationNumber": "12345678",
    "vatNumber": "12345678",
    "website": "http://mycompany.com",
    "companyTradingAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "companyRegisteredAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "relevantIndividuals": [
      {
        "role": "OWNER",
        "name": "Fred G. Stringer",
        "dateOfBirth": "1972-06-08",
        "address": {
          "address1": "Address line 1",
          "address2": " Address line 2",
          "address3": " Address line 3",
          "postalCode": "12345",
          "city": "City",
          "state": "CA",
          "countryCode": "US"
        },
        "pctOwnership": 30
      }
    ],
    "bankAccount": {
      "bankName": "Wells Fargo",
      "accountHolderName": "Company name",
      "accountNumber": "12345678",
      "sortCode": "01-01-01",
      "IBAN": "ES35 6743 7823 4567 8901",
      "routingNumber": "123456"
    }
}

Body Params

partnerId
string
traderId
string
user
object
required
 
user.email
string
companyTradingName
string
traderSlug
string
companyRegisteredName
string
companyType
string
registrationNumber
string
vatNumber
string
website
string
companyTradingAddress
object
 
companyTradingAddress.address1
string
companyTradingAddress.address2
string
companyTradingAddress.address3
string
companyTradingAddress.postalCode
string
companyTradingAddress.city
string
companyTradingAddress.state
string
companyTradingAddress.countryCode
string
companyRegisteredAddress
object
 
companyRegisteredAddress.address1
string
companyRegisteredAddress.address2
string
companyRegisteredAddress.address3
string
companyRegisteredAddress.postalCode
string
companyRegisteredAddress.city
string
companyRegisteredAddress.state
string
companyRegisteredAddress.countryCode
string
relevantIndividuals
object
 
relevantIndividuals.role
string
relevantIndividuals.name
string
relevantIndividuals.dateOfBirth
yyyy-mm-dd
relevantIndividuals.address
string
relevantIndividuals.pctOwnership
integer
bankAccount
object
 

Headers

Content-Type
string
 
Suggest Edits

Update trader

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.yordex.com/v1/traders
curl https://api.yordex.com/v1/traders  
-H "Content-type: application/json"  
-H "Accept: application/json"  
-X PUT  
-d '{ 
    "companyTradingName": "Company name",
    "companyRegisteredName": "Official company name",
    "traderSlug": "company-name",
    "companyType": "Limited Liability Company",
    "registrationNumber": "12345678",
    "vatNumber": "12345678",
    "website": "http://mycompany.com",
    "companyTradingAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "companyRegisteredAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "relevantIndividuals": [
      {
        "role": "OWNER",
        "name": "Fred G. Stringer",
        "dateOfBirth": "1972-06-08",
        "address": {
          "address1": "Address line 1",
          "address2": " Address line 2",
          "address3": " Address line 3",
          "postalCode": "12345",
          "city": "City",
          "state": "CA",
          "countryCode": "US"
        },
        "pctOwnership": 30
      }
    ],
    "bankAccount": {
      "bankName": "Wells Fargo",
      "accountHolderName": "Company name",
      "accountNumber": "12345678",
      "sortCode": "01-01-01",
      "IBAN": "ES35 6743 7823 4567 8901",
      "routingNumber": "123456"
    }
}'
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Address tradingAddress = Address.builder().
        address1("address1").city("city").postalCode("postalCode").countryCode("GB").build();
Address registeredAddress = Address.builder().
        address1("address1").city("city").postalCode("postalCode").countryCode("GB").build();
Trader updatedTrader = Trader.builder().
        companyTradingName("tradingName").
        companyRegisteredName("registeredName").
        companyTradingAddress(tradingAddress).
        companyRegisteredAddress("registeredAddress").
        build();
updatedTrader = Trader.update(traderId, updatedTrader, requestOptions);
A binary file was returned

You couldn't be authenticated

{ 
    "id": "trader-id",
    "partnerId": "your-partner-id",
    "traderId": "your-trader-id",
    "companyTradingName": "Company name",
    "traderSlug": "company-name",
    "companyRegisteredName": "Official company name",
    "companyType": "Limited Liability Company",
    "registrationNumber": "12345678",
    "vatNumber": "12345678",
    "website": "http://mycompany.com",
    "companyTradingAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "companyRegisteredAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "relevantIndividuals": [
      {
        "role": "OWNER",
        "name": "Fred G. Stringer",
        "dateOfBirth": "1972-06-08",
        "address": {
          "address1": "Address line 1",
          "address2": " Address line 2",
          "address3": " Address line 3",
          "postalCode": "12345",
          "city": "City",
          "state": "CA",
          "countryCode": "US"
        },
        "pctOwnership": 30
      }
    ],
    "bankAccount": {
      "bankName": "Wells Fargo",
      "accountHolderName": "Company name",
      "accountNumber": "12345678",
      "sortCode": "01-01-01",
      "IBAN": "ES35 6743 7823 4567 8901",
      "routingNumber": "123456"
    }
}

Body Params

companyTradingName
string
companyRegisteredName
string
traderSlug
string
companyType
string
registrationNumber
string
vatNumber
string
website
string
companyTradingAddress
object
 
companyTradingAddress.address1
string
companyTradingAddress.address2
string
companyTradingAddress.address3
string
companyTradingAddress.postalCode
string
companyTradingAddress.city
string
companyTradingAddress.state
string
companyTradingAddress.countryCode
string
companyRegisteredAddress
object
 
companyRegisteredAddress.address1
string
companyRegisteredAddress.address2
string
companyRegisteredAddress.address3
string
companyRegisteredAddress.postalCode
string
companyRegisteredAddress.city
string
companyRegisteredAddress.state
string
companyRegisteredAddress.countryCode
string
relevantIndividuals
object
 
relevantIndividuals.role
string
relevantIndividuals.name
string
relevantIndividuals.dateOfBirth
yyyy-mm-dd
relevantIndividuals.address
string
relevantIndividuals.pctOwnership
integer
bankAccount
object
 

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Get trader

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/traders/traderId
curl https://api.yordex.com/v1/traders/trader-id
-H "Content-type: application/json"  
-H "Accept: application/json"  
-X GET
A binary file was returned

You couldn't be authenticated

{ 
    "id": "trader-id",
    "partnerId": "your-partner-id",
    "traderId": "your-trader-id",
    "companyTradingName": "Company name",
    "traderSlug": "company-name",
    "companyRegisteredName": "Official company name",
    "companyType": "Limited Liability Company",
    "registrationNumber": "12345678",
    "vatNumber": "12345678",
    "website": "http://mycompany.com",
    "companyTradingAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "companyRegisteredAddress": {
      "address1": "Address line 1",
      "address2": " Address line 2",
      "address3": " Address line 3",
      "postalCode": "12345",
      "city": "City",
      "state": "CA",
      "countryCode": "US"
    },
    "relevantIndividuals": [
      {
        "role": "OWNER",
        "name": "Fred G. Stringer",
        "dateOfBirth": "1972-06-08",
        "address": {
          "address1": "Address line 1",
          "address2": " Address line 2",
          "address3": " Address line 3",
          "postalCode": "12345",
          "city": "City",
          "state": "CA",
          "countryCode": "US"
        },
        "pctOwnership": 30
      }
    ],
    "bankAccount": {
      "bankName": "Wells Fargo",
      "accountHolderName": "Company name",
      "accountNumber": "12345678",
      "sortCode": "01-01-01",
      "IBAN": "ES35 6743 7823 4567 8901",
      "routingNumber": "123456"
    }
}

Path Params

traderId
string
required

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Get all traders

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/traders
curl https://api.yordex.com/v1/traders?knownTraders=true
-H "Content-type: application/json"  
-X GET
A binary file was returned

You couldn't be authenticated

{
  "links": [
    {
      "rel": "self",
      "href": "http://api.yordex.com/traders?knownTraders=true"
    }
  ],
  "content": [
    {
  		"id" : "trader-id",
  		"companyTradingName" : "Company name"
    }
  ],
  "page": {
    "size": 10,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

Query Params

page
int32
size
int32
sort
string
knownTraders
boolean
q
string

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Lineitems fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this line item

orderId

String, returned in the response
Id of the order that this line item is associated with

type

String, mandatory
Possible values are PRODUCT, COST or CREDIT

name

String, mandatory
Name of the product, cost or credit

buyerProductReference

String, optional
The product number by which this product is known in the buyer's systems.

sellerProductReference

String, optional
The product number by which this product is known in the seller's product catalogue.

listPriceInCents

String, mandatory
Price for a single item of the product, service, cost or credit. The currency of the line item is always the same as the orderCurrency of the order this line item is associated with.

quantity

Number, optional
Quantity of goods or services being ordered. This field is only required if this line item is for a product or service which means the type field should not be set

discount

Number, optional
The discount over the list price in percentage. For example, if this field is set to 10 that means there is a 10% discount. This field can not be set for COST or CREDIT line items.

vat

Number, optional
The VAT or GST over the list price in percentage. For example, if this field is set to 20 that means there is a 20% VAT or GST. This field can not be set for COST or CREDIT line items.

unitOfMeasure

String, optional
The definition of 1 quantity item. For example, "quantity":1 could mean 1 item, 1 package or 1 pallet

quantityPieces

Integer, optional
The number of items in 1 unit of measure

vatAmountInCents

Number, optional
The total amount of VAT or GST for this line item. It is possible to specify this field directly when creating a line item in which case the "vat" field should not be specified.

lineItemAmountInCents

Number, Yordex generated
The total amount for this line item including discounts and taxes. For costs and credits this will always be the same as the listPriceInCents.

buyerCostAllocation

Array, optional
An array of budget(s) that this line item should be charged to for the buyer.

sellerCostAllocation

Array, optional
An array of budget(s) that this line item should be charged to for the seller.

. budget

Object, mandatory when a buyer/sellerCostAllocation is provided
The budget that this line item is charged to. Fields used here are customised to your cost centre hierarchy.

. allocation

Object, mandatory when a buyer/sellerCostAllocation is provided
The % of the line item that is assigned to this budget.

. budgetName

String, Yordex generated
The name of the budget to be used for display and reporting purposes only.

Suggest Edits

Add line item to order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/orderId/lineitems
curl https://api.yordex.com/v1/orders/:orderId/lineitems
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST
-d '{
  "type" : "PRODUCT",
  "name" : "Armchair",
  "buyerProductReference" : "ABC1234",
  "sellerProductReference" : "ABC1234",
  "listPriceInCents" : 10000,
  "quantity" : 50,
  "discount" : 10,
  "vat" : 20,
  "unitOfMeasure":"PIECES",
  "quantityPieces":20,
  "buyerCostAllocation": [
    {
      "budget": {
        "department": "Marketing",
        "costCentre": "Marketing,4890"
      },
      "allocation": 100
    }
  ]  
}'
A binary file was returned

You couldn't be authenticated

{
  "id" : "id",
  "orderId" : "order-id",
  "type" : "PRODUCT",
  "name" : "Armchair",
  "buyerProductReference" : "ABC1234",
  "sellerProductReference" : "ABC1234",
  "listPriceInCents" : 10000,
  "quantity" : 50,
  "discount" : 10,
  "vat" : 20,
  "unitOfMeasure":"PIECES",
  "quantityPieces":20,
  "vatAmountInCents" : 90000,
  "lineItemAmountInCents" : 540000,
  "buyerCostAllocation": [
    {
      "budget": {
        "department": "Marketing",
        "costCentre": "Marketing,4890"
      },
      "allocation": 100
    }
  ]
}

Path Params

orderId
string
required

Body Params

type
string
required
name
string
required
buyerProductReference
string
sellerProductReference
string
listPriceInCents
int32
quantity
int32
discount
int32
vat
int32
unitOfMeasure
string
quantityPieces
int32
buyerCostAllocation
array

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Add line item from catalogue

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/orders/orderId/lineitems
curl https://api.yordex.com/v1/orders/:orderId/lineitems
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST
-d '{
  "termLineItemId" : "id"
}'
A binary file was returned

You couldn't be authenticated

{
  "id" : "id",
  "orderId" : "order-id",
  "type" : "PRODUCT",
  "name" : "Armchair",
  "buyerProductReference" : "ABC1234",
  "sellerProductReference" : "DEF1234",
  "listPriceInCents" : 10000,
  "quantity" : 50,
  "discount" : 10,
  "vat" : 20,
  "unitOfMeasure":"PIECES",
  "quantityPieces":20,
  "vatAmountInCents" : 90000,
  "lineItemAmountInCents" : 540000,
  "buyerCostAllocation": [
    {
      "budget": {
        "department": "Marketing",
        "costCentre": "Marketing,4890"
      },
      "allocation": 100
    }
  ]
}

Path Params

orderId
string
required

Body Params

termLineItemId
string
required

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Update line item

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.yordex.com/v1/orders/orderId/lineitems/lineItemId
curl https://api.yordex.com/v1/orders/:orderId/lineitems/line-item-id
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PUT
-d '{
  "type" : "PRODUCT",
  "name" : "Armchair",
  "buyerProductReference" : "ABC1234",
  "sellerProductReference" : "ABC1234",
  "listPriceInCents" : 10000,
  "quantity" : 50,
  "discount" : 10,
  "vat" : 20,
  "unitOfMeasure":"PIECES",
  "quantityPieces":20,
  "buyerCostAllocation": [
    {
      "budget": {
        "department": "Marketing",
        "costCentre": "Marketing,4890"
      },
      "allocation": 100
    }
  ]  
}'
A binary file was returned

You couldn't be authenticated

{
  "id" : "id",
  "orderId" : "order-id",
  "type" : "PRODUCT",
  "name" : "Armchair",
  "buyerProductReference" : "ABC1234",
  "sellerProductReference" : "ABC1234",
  "listPriceInCents" : 10000,
  "quantity" : 50,
  "discount" : 10,
  "vat" : 20,
  "unitOfMeasure":"PIECES",
  "quantityPieces":20,
  "vatAmountInCents" : 90000,
  "lineItemAmountInCents" : 540000,
  "buyerCostAllocation": [
    {
      "budget": {
        "department": "Marketing",
        "costCentre": "Marketing,4890"
      },
      "allocation": 100
    }
  ]  
}

Path Params

orderId
string
required
lineItemId
string
required

Body Params

type
string
required
name
string
required
buyerProductReference
string
sellerProductReference
string
listPriceInCents
int32
quantity
int32
discount
int32
vat
int32
unitOfMeasure
string
quantityPieces
string
buyerCostAllocation
array of objects
budget 
allocation

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Delete line item

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.yordex.com/v1/orders/orderId/lineitems/lineItemId
curl https://api.yordex.com/v1/orders/:orderId/lineitems/line-item-id
-H "Authorization:your-api-key"  
-X DELETE
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
string
required
lineItemId
string
required

Headers

Authorization
string
 
Suggest Edits

Get line item

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/orders/orderId/lineitems/:lineItemId
curl https://api.yordex.com/v1/orders/:orderId/lineitems?orderId=order-id
-H "Authorization:your-api-key"  
-X GET
A binary file was returned

You couldn't be authenticated

{
  "lineItems" : [
    {
      "id" : "id",
      "orderId" : "order-id",
      "type" : "PRODUCT",
      "name" : "Armchair",
      "buyerProductReference" : "ABC1234",
      "sellerProductReference" : "ABC1234",
      "listPriceInCents" : 10000,
      "quantity" : 50,
      "discount" : 10,
      "vat" : 20,
      "unitOfMeasure":"PIECES",
      "quantityPieces":20,
      "vatAmountInCents" : 90000,
      "lineItemAmountInCents" : 540000,
      "buyerCostAllocation": [
        {
          "budget": {
            "department": "Marketing",
            "costCentre": "Marketing,4890"
          },
          "allocation": 100
        }
      ]  
    }
  ]
}

Query Params

orderId
string

Headers

Authorization
string
 
Suggest Edits

Get all line items

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/orders/orderId/lineitems
curl https://api.yordex.com/v1/orders/:orderId/lineitems
-H "Authorization:your-api-key"  
-X GET
A binary file was returned

You couldn't be authenticated

{
  "lineItems" : [
    {
      "id" : "id",
      "orderId" : "order-id",
      "type" : "PRODUCT",
      "name" : "Armchair",
      "buyerProductReference" : "ABC1234",
      "sellerProductReference" : "ABC1234",
      "listPriceInCents" : 10000,
      "quantity" : 50,
      "discount" : 10,
      "vat" : 20,
      "unitOfMeasure":"PIECES",
      "quantityPieces":20,
      "vatAmountInCents" : 90000,
      "lineItemAmountInCents" : 540000,
      "buyerCostAllocation": [
        {
          "budget": {
            "department": "Marketing",
            "costCentre": "Marketing,4890"
          },
          "allocation": 100
        }
      ]  
    }
  ]
}

Path Params

orderId
string
required

Headers

Authorization
string
 
Suggest Edits

Paymentrecords Fields

 
Field
Description

orderId

String, mandatory
The id of the order that this payment is linked to

eventId

String, mandatory
The id of the event that this payment is linked to

date

String, Yordex generated
The date that the payment was made using the ISO-8601 standard

service

String, optional
The payment service that this payment was made through. If this field is not provided, buyer and seller made their own payment arrangements

type

String, mandatory
Possible types are PAYMENT and FEE

amountInCents

Number, mandatory
The amount of the payment

currency

String, mandatory
The currency of the amountInCents using the ISO-4217 standard

currencyExponent

String, Yordex generated
Indicates how many numbers at the end of the amountInCents are reserved for cents.

exchangeRate

String, Yordex generated
The exchange rate applied between the amountInCents and the receivedAmountInCents

receivedAmountInCents

Number, Yordex generated
The amount of the payment after it is exchanged to the receivedCurrency

receivedCurrency

String, Yordex generated
The currency of the receivedAmountInCents using the ISO-4217 standard

receivedCurrencyExponent

String, Yordex generated
Indicates how many numbers at the end of the receivedAmountInCents are reserved for cents

Suggest Edits

Recording an own payment

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/paymentrecords
curl https://api.yordex.com/v1/paymentrecords 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{ 
    "orderId":"order-id",
    "eventId":"event-id",
    "type":"PAYMENT",    
    "amountInCents": 100000,
    "currency":"USD"
}'
A binary file was returned

You couldn't be authenticated

{ 
  "date":"2016-11-29",
  "orderId":"order-id",
  "eventId":"event-id",
  "type":"PAYMENT",  
  "amountInCents":100000,
  "currency":"USD",
  "currencyExponent":2
}

Body Params

orderId
string
required
eventId
string
required
type
string
amountInCents
int32
currency
string

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Getting payments

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/paymentrecords?orderId=order-id&eventId=event-id
curl https://api.yordex.com/v1/paymentrecords?eventId=event-id 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X GET 
A binary file was returned

You couldn't be authenticated

{ 
  [
    {
      "date":"2016-12-02",
      "orderId":"order-id",
      "eventId":"event-id",
      "type":"PAYMENT",
      "amountInCents": 106511,
      "currency": "EUR",
      "currencyExponent": 2,
      "exchangeRate":1.06511,
      "receivedAmountInCents": 100000,
      "receivedCurrency": "USD",
      "receivedCurrencyExponent": 2
    },
    {
      "date":"2016-12-03",
      "orderId":"order-id",
      "eventId":"event-id",
      "type":"FEE",
      "amountInCents": 500,
      "currency": "USD",
      "currencyExponent": 2
    }
  ]
}

Query Params

orderId
string
eventId
string

Headers

Authorization
string
Content-Type
string
 
Suggest Edits

Documents Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this document

type

String, mandatory
The table below specifies all document types and their upload restrictions

orderId

String, mandatory
The id of the order that this document is uploaded to

eventId

String, optional
The id of the event that this document is uploaded to. Only required if the type of the document is EVENT

documentDate

String, optional
The date of this document, e.g. the invoice date, using the ISO-8601 standard.

customerDocumentId

String, optional
The reference of this document, e.g. the invoice reference

fileName

String, mandatory
The filename of the document that is uploaded

name

String, optional
The name under which this document is known in Yordex. When the type of the document is EVENT, this field is used for matching the document to one of the fields in the documentsRequired array of the event

base64EncodedContent

String, mandatory
The base64 encoded document

location

String, Yordex provided
The location where the document is stored. This is an API end-point so the document cannot be downloaded directly from the browser. It has to be downloaded from a server

Document type
Description

INVOICE

An invoice. The invoice has to be attached to an event. Only one invoice can be provided per event. If a new invoice is provided, the old one will be overwritten

ORDER

A document attached to an order. Every order can have up to 5 documents attached to it. The "name" field is not used for this type of documents.

EVENT

A document attached to an event. Every event can have up to 5 documents attached to it. The "name" field should correspond to one of the fields in the "documentsRequired" array of the event

Suggest Edits

Upload document

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/documents
curl https://api.yordex.com/v1/documents 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{ 
    "type": "INVOICE",
    "orderId":"order-id",
    "eventId":"event-id",
    "documentDate" : "2017-06-03",  
    "customerDocumentId" : "INV-001",  
    "fileName":"invoice.pdf",
    "name":"Invoice",
    "base64EncodedContent":"base64 encoded document",
}'
A binary file was returned

You couldn't be authenticated

{ 
  "id": "document-id",
  "type": "INVOICE",
  "orderId":"order-id",
  "eventId":"event-id",
  "documentDate" : "2017-06-03",  
  "customerDocumentId" : "INV-001",  
  "fileName":"invoice-123.pdf",
  "name":"Invoice",
  "location":"https://api.yordex.com/documents/download/document-id"
}

Body Params

type
string
orderId
string
eventId
string
documentDate
date
customerDocumentId
string
fileName
string
name
string
base64EncodedContent
string

Headers

Authorization
string
 
Suggest Edits

Delete document

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.yordex.com/v1/documents/documentId
curl https://api.yordex.com/v1/documents/:documentId
-H "Authorization:your-api-key"  
-X DELETE 
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

documentId
string
required

Headers

Authorization
string
 
Suggest Edits

Trader Order Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this trader order

type

String, mandatory
The table below specifies all document types and their upload restrictions

status

String, Yordex generated
The status of this event. Possible values are listed on the right

fileName

String, mandatory
The filename of the document that is uploaded

originalInvoiceType

String, mandatory
The media type of this document

base64EncodedContent

String, mandatory
The base64 encoded document

location

String, Yordex provided
The location where the document is stored. This is an API end-point so the document cannot be downloaded directly from the browser. It has to be downloaded from a server

traderIds

Array, Yordex generated
The buyer or seller of this order. This field will only be populated once the trader order was matched.

userIds

Array, Yordex generated
The users responsible for this order. This field will only be populated once the trader order was matched.

scanResults

Object, optional and Yordex generated
The content of the document. This can be provided when creating the trader order or Yordex can provide it when OCR scanning the document

. poNumber

String, optional
This field will be used to attempt to match the trader order with an order. It will also be used when creating a new order from this trader order.

. invoiceCurrency

String, mandatory

. invoiceAmountInCents

String, mandatory

. invoiceDate

String, mandatory

. invoiceNumber

String, optional

. sellerCompanyName

String, optional
This field will be used to attempt to match the trader order with an order

. description

String, optional
This field will be used to attempt to match the trader order with an order. It will also be used when creating a new order from this trader order.

. paymentDueDate

String, optional
This field will be used to attempt to match the trader order with an order. It will also be used when creating a new order from this trader order.

Trader order type
Description

INVOICE

An invoice. Once matched, a trader order of type invoice will be attached to the order as an invoice.

PAYMENT

An payment record taken from a bank statement, a credit card statement or an accounting system. Once matched, a trader order of type payment will record a payment for that order.

RECEIPT_NOTE

An receipt note. Once matched, a trader order of type invoice will confirm the event on behalf of the buyer.

SHIPPING_NOTE

An shipping note. Once matched, a trader order of type invoice will confirm the event on behalf of the seller.

PROCESSING

We are still OCR scanning the document to read the contents of the document

MATCHING

We are still finding the right order that matches with this trader order

COMPLETED

The trader order has been matched with an order and the action corresponding to the type of this trader order has been completed

Suggest Edits

Upload trader order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/traderorders
curl https://api.yordex.com/v1/traderorders 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{ 
    "type": "INVOICE",
    "sellerId":"id",
    "emails":["sender@company.com"],
    "fileName":"INV001.pdf",
    "originalInvoiceType" : "application/pdf",
    "base64EncodedContent":"base64 encoded document",
    "scanResults" : [
      "poNumber" : "PO5738753",
      "invoiceCurrency" : "USD",
      "invoiceAmountInCents" : 1000000,
      "invoiceDate" : "2018-11-12",
      "invoiceNumber" : "INV-001",
      "sellerCompanyName" : "ACME LLC",
      "description" : "description",
      "paymentDueDate" : "2019-01-10"
    ] 
}'
A binary file was returned

You couldn't be authenticated

{
  "id": "trader-order-id",
  "type": "INVOICE",
  "fileName": "INV001.pdf",
  "originalInvoiceType": "application/pdf",
  "status": "MATCHING",
  "traderIds": [
    "id"
  ],
  "userIds": [
    "sender@company.com"
  ],
  "location": "https://api.test.yordex.com/traderorders/download/id",
  "scanResults" : [
      "poNumber" : "PO5738753",
      "invoiceCurrency" : "USD",
      "invoiceAmountInCents" : 1000000,
      "invoiceDate" : "2018-11-12",
      "invoiceNumber" : "INV-001",
      "sellerCompanyName" : "ACME LLC",
      "description" : "description",
      "paymentDueDate" : "2019-01-10"
  ]
}

Body Params

type
string
required
sellerId
string
emails
array of strings
fileName
string
originalInvoiceType
string
base64EncodedContent
string
scanResults
array of strings

Headers

Authorization
string
 
Suggest Edits

Add line items to trader order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/traderorders/:id/lineitems
curl https://api.yordex.com/v1/traderorders/:id/lineitems
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST
-d '{
  "type" : "PRODUCT",
  "name" : "Armchair",
  "buyerProductReference" : "ABC1234",
  "listPriceInCents" : 10000,
  "quantity" : 50,
  "discount" : 10,
  "vat" : 20
}'
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

type
string
required
name
string
required
buyerProductReference
string
sellerProductReference
string
listPriceInCents
int32
required
quantity
int32
required
discount
int32
vat
int32

Headers

Authorization
string
 
Suggest Edits

Tabs Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this tab

name

String, optional
The name of this tab

userId

String, optional
The id of the user who this tab belongs to

tabFilter

String, mandatory
A regular expression indicating which events are included in this tab. See Using tabs for an explanation of how to write this expression

results

Array, Yordex generated
An array of all results. Results are grouped by currency.

. currency

String, Yordex generated
The currency for this set of results

. currencyComponent

Number, Yordex generated
Indicates how many numbers at the end are reserved for cents. For most currencies this will be “2” : they have 2 digits so 100 cents. Some currencies have 0, 1 or 3 numbers. You will find a full list of supported currencies and their exponents here

. amountInCents

Number, Yordex generated
The sum of the amountToBePaidInCents for all the events included in this tab with this currency

. receivedAmountInCents

Number, Yordex generated
The sum of the receivedAmountInCents for all the events included in this tab with this currency

. events

Array, Yordex generated
List of all events included in this tab with this currency as the orderCurrency. For every event, the orderId and eventId are listed.

Suggest Edits

Create tabs

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/tabs
curl https://api.yordex.com/v1/tabs  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST 
-d '{
  "name":"Payments due next week",
  "userId":"user-id",
  "tabFilter":"#event.paymentDueDate >= date.now() and #event.paymentDueDate <= date.now().plusDays(7)"
}'
A binary file was returned

You couldn't be authenticated

{
  "id":"tab-id",
  "name":"Payments due next week",
  "userId":"user-id",
  "tabFilter":"#event.paymentDueDate >= date.now() and #event.paymentDueDate <= date.now().plusDays(7)",
  "results": [
    {
      "currency": "USD",
      "currencyComponent": 2,
      "amountInCents": 300000,
      "receivedAmountInCents": 100000,
      "events": [
        {
          "orderId": "order-id-1",
          "eventId": "event-id-1"
        },
        {
          "orderId": "order-id-2",
          "eventId": "event-id-2"
        }
      ]
    }
  ]
}

Body Params

name
string
userId
string
tabFilter
string
required

Headers

Authorization
string
 
Suggest Edits

Update tabs

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.yordex.com/v1/tabs/tabId
curl https://api.yordex.com/v1/tabs/tab-id
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PUT 
-d '{
  "name":"Payments due next week",
  "userId":"user-id",
  "tabFilter":"#event.paymentDueDate >= date.now() and #event.paymentDueDate <= date.now().plusDays(7)"
}'
A binary file was returned

You couldn't be authenticated

{
  "id":"tab-id",
  "name":"Payments due next week",
  "userId":"user-id",
  "tabFilter":"#event.paymentDueDate >= date.now() and #event.paymentDueDate <= date.now().plusDays(7)",
  "results": [
    {
      "currency": "USD",
      "currencyComponent": 2,
      "amountInCents": 300000,
      "receivedAmountInCents": 100000,
      "events": [
        {
          "orderId": "order-id-1",
          "eventId": "event-id-1"
        },
        {
          "orderId": "order-id-2",
          "eventId": "event-id-2"
        }
      ]
    }
  ]
}

Path Params

tabId
string
required

Body Params

name
string
userId
string
tabFilter
string
required

Headers

Authorization
string
 
 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/tabs/tabId
curl https://api.yordex.com/v1/tabs/tab-id
-H "Authorization:your-api-key"  
-X GET 
A binary file was returned

You couldn't be authenticated

{
  "id":"tab-id",
  "name":"Payments due next week",
  "userId":"user-id",
  "tabFilter":"#event.paymentDueDate >= date.now() and #event.paymentDueDate <= date.now().plusDays(7)",
  "results": [
    {
      "currency": "USD",
      "currencyComponent": 2,
      "amountInCents": 300000,
      "receivedAmountInCents": 100000,
      "events": [
        {
          "orderId": "order-id-1",
          "eventId": "event-id-1"
        },
        {
          "orderId": "order-id-2",
          "eventId": "event-id-2"
        }
      ]
    }
  ]
}

Path Params

tabId
string
required

Headers

Authorization
string
 
Suggest Edits

Get all tabs

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/tabs
curl https://api.yordex.com/v1/tabs
-H "Authorization:your-api-key"  
-X GET 
A binary file was returned

You couldn't be authenticated

{
  "tabs" : [
    {
      "id":"tab-id",
      "name":"Payments due next week",
      "tabFilter":"#event.paymentDueDate >= date.now() and #event.paymentDueDate <= date.now().plusDays(7)"
    }
  ]
}

Path Params

tabId
string
required

Query Params

userId
string
nextApproverUserId
string

Headers

Authorization
string
 
Suggest Edits

Approve tab

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/tabs/tabId/approvals
curl https://api.yordex.com/v1/tabs/tab-id/approvals
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PUT 
-d '{
  "userId":"user-id",
  "approved":true
}'
A binary file was returned

You couldn't be authenticated

{
  "id":"tab-id",
  "name":"Payments due next week",
  "userId":"user-id",
  "tabFilter":"#event.paymentDueDate >= date.now() and #event.paymentDueDate <= date.now().plusDays(7)",
  "results": [
    {
      "currency": "USD",
      "currencyComponent": 2,
      "amountInCents": 300000,
      "receivedAmountInCents": 100000,
      "events": [
        {
          "orderId": "order-id-1",
          "eventId": "event-id-1"
        },
        {
          "orderId": "order-id-2",
          "eventId": "event-id-2"
        }
      ]
    }
  ]
}

Path Params

tabId
string
required

Body Params

userId
string
approved
boolean
required

Headers

Authorization
string
 
Suggest Edits

Terms Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this term

name

String, mandatory
Name for these terms. This field is used in the "terms" field of the Orders API and has to be unique

All other fields

All other fields of the Terms API have the same meaning as in the Events API

Suggest Edits

Create terms

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/terms
curl https://api.yordex.com/v1/terms  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{
  "name": "30% upfront 70% before shipping",
  "events": [
    {
      "eventName": "Order approved",
      "paymentName": "Deposit",
      "eventNumber": 1,
      "pctToBePaid": 30
    },
    {
      "eventName": "Goods ready for shipping",
      "paymentName": "Full payment",
      "creditTerms": 14,
      "creditTermsFrom": 14,
      "eventNumber": 2,
      "pctToBePaid": 70,
      "confirmers": ["BUYER","SELLER"],
      "documentsRequired": ["bill of lading"],
      "earlyPaymentDiscount" : { 
        "discountPct":2.01, 
        "expiryDays":10
      }
    }
  ]
}'
A binary file was returned

You couldn't be authenticated

{
  "id": "term-id",
  "name": "30% upfront 70% before shipping",
  "events": [
    {
      "eventName": "Order approved",
      "paymentName": "Deposit",
      "eventNumber": 1,
      "pctToBePaid": 30
    },
    {
      "eventName": "Goods ready for shipping",
      "paymentName": "Full payment",
      "creditTerms": 14,
      "creditTermsFrom": 14,
      "eventNumber": 2,
      "pctToBePaid": 70,
      "confirmers": ["BUYER","SELLER"],
      "documentsRequired": ["bill of lading"],
      "earlyPaymentDiscount" : { 
        "discountPct":2.01, 
        "expiryDays":10
      }
    }
  ]
}

Body Params

name
string
events
array of objects
eventName
paymentName
creditTerms
creditTermsFrom
eventNumber
pctToBePaid
confirmers
documentsRequired

Headers

Authorization
string
 
Suggest Edits

Update terms

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.yordex.com/v1/terms/term-id
curl https://api.yordex.com/v1/terms/term-id 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PUT  
-d '{
  "name": "30% upfront 70% before shipping",
  "events": [
    {
      "eventName": "Order approved",
      "paymentName": "Deposit",
      "eventNumber": 1,
      "pctToBePaid": 30
    },
    {
      "eventName": "Goods ready for shipping",
      "paymentName": "Full payment",
      "creditTerms": 14,
      "eventNumber": 2,
      "pctToBePaid": 70,
      "confirmers": ["BUYER","SELLER"],
      "documentsRequired": ["bill of lading"],
      "earlyPaymentDiscount" : { 
        "discountPct":2.01, 
        "expiryDays":10
      }
    }
  ]
}'
A binary file was returned

You couldn't be authenticated

{
  "id": "term-id",
  "name": "30% upfront 70% before shipping",
  "events": [
    {
      "eventName": "Order approved",
      "paymentName": "Deposit",
      "eventNumber": 1,
      "pctToBePaid": 30
    },
    {
      "eventName": "Goods ready for shipping",
      "paymentName": "Full payment",
      "creditTerms": 14,
      "eventNumber": 2,
      "pctToBePaid": 70,
      "confirmers": ["BUYER","SELLER"],
      "documentsRequired": ["bill of lading"],
      "earlyPaymentDiscount" : { 
        "discountPct":2.01, 
        "expiryDays":10
      }
    }
  ]
}

Path Params

term-id
string
required

Body Params

name
string
events
array of objects
eventName
paymentName
creditTerms
creditTermsFrom
eventNumber
pctToBePaid
confirmers
documentsRequired

Headers

Authorization
string
 
Suggest Edits

Get terms

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/terms/term-id
curl https://api.yordex.com/v1/terms/term-id 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X GET  
A binary file was returned

You couldn't be authenticated

{
  "id": "term-id",
  "name": "30% upfront 70% before shipping",
  "events": [
    {
      "eventName": "Order approved",
      "paymentName": "Deposit",
      "eventNumber": 1,
      "pctToBePaid": 30
    },
    {
      "eventName": "Goods ready for shipping",
      "paymentName": "Full payment",
      "creditTerms": 14,
      "eventNumber": 2,
      "pctToBePaid": 70,
      "confirmers": ["BUYER","SELLER"],
      "documentsRequired": ["bill of lading"],
      "earlyPaymentDiscount" : { 
        "discountPct":2.01, 
        "expiryDays":10
      }
    }
  ]
}

Path Params

term-id
string
required

Headers

Authorization
string
 
Suggest Edits

Get all terms

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/terms
curl https://api.yordex.com/v1/terms
-H "Authorization:your-api-key"  
-X GET  
A binary file was returned

You couldn't be authenticated

{
  "links": [
    {
      "rel": "self",
      "href": "https://api.yordex.com/terms"
    }
  ],
  "content": [
    {
      "id": "term-id-1",
      "name": "30% upfront 70% before shipping",
      "traderId": "trader-id",
      "events": [
        {
          "eventName": "Order approved",
          "paymentName": "Deposit",
          "eventNumber": 1,
          "pctToBePaid": 30
        },
        {
          "eventName": "Goods ready for shipping",
          "paymentName": "Final payment",
          "creditTerms": 14,
          "creditTermsFrom": 14,
          "eventNumber": 2,
          "pctToBePaid": 70,
          "confirmers": ["BUYER","SELLER"],
          "documentsRequired": ["bill of lading"],
          "earlyPaymentDiscount" : { 
            "discountPct":2.01, 
            "expiryDays":10
          }
        }
      ]
    },
    {
      "id": "term-id-2",
      "name": "One-off payment",
      "traderId": "trader-id",
      "events": [
        {
          "eventName": "Order approved",
          "paymentName": "Full payment",
          "creditTerms": 14,
          "creditTermsFrom": 14,
          "eventNumber": 1,
          "pctToBePaid": 100
        }
      ]
    }
  ],
  "page": {
    "size": 10,
    "totalElements": 2,
    "totalPages": 1,
    "number": 0
  }
}

Headers

Authorization
string
 
Suggest Edits

Delete terms

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.yordex.com/v1/terms/term-id
curl https://api.yordex.com/v1/terms/term-id 
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X DELETE
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

term-id
string
required

Headers

Authorization
string
 
Suggest Edits

Relations Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this relation

traderId

String, Yordex generated
id of the trader that this relation is with

status

String, Yordex generated
The approval status for this trader. The full list of relation statuses can be found on the right.

ownerUserId

String, optional
User id of the user that owns the relation with this other company

approverUserId

String, optional
User id of the user who approves the relation with this other company

traderForm

Object, optional
Additional data about this trader. This is a list of free form key:value pairs

Relation Status
Description

INSUFFICIENT_DATA

Insufficient data available to approve the supplier. What "sufficient" is can be defined by you.

FOR_APPROVAL

Sufficient data available to approve the supplier but not yet approved

FOR_SETUP

The supplier is approved but not yet set up in your ERP system

COMPLETED

The supplier is approved and the data is fully synched with your ERP system

Suggest Edits

Update relation

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.yordex.com/v1/relations/relationId
curl https://api.yordex.com/v1/relations/relation-id  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PUT  
-d '{ 
  "approverUserId" : "user-id-1",
  "ownerUserId" : "user-id-2",
  "traderForm" : {
    "q1" : "a1",
    "q2" : "a2"
  }
}'
A binary file was returned

You couldn't be authenticated

{
  "id" : "relation-id",
  "status": "COMPLETED",
  "traderId" : "trader-id",
  "approverUserId" : "user-id-1",
  "ownerUserId" : "user-id-2",
  "traderForm" : {
    "q1" : "a1",
    "q2" : "a2"
  }
}

Path Params

relationId
string
required

Query Params

ownerUserId
string
approverUserId
string
traderForm
object
 
traderForm.accountingCode
string
 
Suggest Edits

Get relations

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/relations?traderId=other-trader-id
curl https://api.yordex.com/v1/relations?traderId=other-trader-id
-H "Authorization:your-api-key"  
-X GET
A binary file was returned

You couldn't be authenticated

[
  "relations" : [
    {
      "id" : "relation-id",
      "status": "COMPLETED",
      "traderId" : "trader-id",
      "approverUserId" : "user-id-1",
      "ownerUserId" : "user-id-2",
      "traderForm" : {
        "q1" : "a1",
        "q2" : "a2"
      }
    }
  ]
]
 
Suggest Edits

Indicate a relation is set up

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/relations/relationId/setup
curl https://api.yordex.com/v1/relations/relation-id/setup  
-H "Authorization:your-api-key"  
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

relationId
string
required
 
Suggest Edits

Approve a relation

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/relations/relationId/approvals
curl https://api.yordex.com/v1/relations/relation-id/approvals  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{ 
  "approved" : true,
  "approverUserId" : "user-id-1"
}'
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

relationId
string
required

Query Params

approved
boolean
approverUserId
string
 
Suggest Edits

Ads Fields

 
Field
Description

service

String, Yordex generated
Name of the service. This is the field to be used when adding this service to the order.

title

String, Yordex generated
The title to be used when displaying the service advertisement to the user. Please use the exact text provided

description

String, Yordex generated
The description to be used when displaying the service advertisement to the user. Please use the exact text provided

feeDescription

String, Yordex generated
The fees for this service expressed as a string.

links

Object, Yordex generated
HATEOAS links to enable and disable the service that is advertised. When invoking the link specified in the link with "rel":"enable", the service advertised will be added to the order. When invoking the link specified in the link with "rel":"disable", the service advertised will be removed from the order.

. rel

String, Yordex generated
The action that this link will trigger. Possible values are "enable" and "disable".

. href

String, Yordex generated
The link that should be invoked to trigger this action

. method

String, Yordex generated
The HTTP method to be used, e.g. POST or DELETE

Suggest Edits

Request ads

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/ads
curl https://api.yordex.com/v1/ads?orderId=order-id
-H "Authorization:your-api-key"  
-X GET
RequestOptions requestOptions = RequestOptions.builder().apiKey("apiKey").build();
Set<Advertisement> ads = Order.getAds(orderId, requestOptions);
A binary file was returned

You couldn't be authenticated

{
  "ads" : [
    {
      "service" : "PROVIDER",
      "title" : "International payments",
      "description" : "<description>",
      "feeDescription" : "GBP 5",
      "links" : [
       {
        "rel": "enable",
        "href": "https://api.yordex.com/orders/order-id/services?service=PROVIDER&buyerCurrency=USD",
        "method": "POST"
       },
       {
        "rel": "disable",
        "href": "https://api.yordex.com/orders/order-id/services?service=PROVIDER",
        "method": "DELETE"
       },
      ]
    }
  ]	
}

Query Params

orderId
string

Headers

Authorization
string
required
 
Suggest Edits

Users Fields

 
Field
Description

id

String, Yordex generated
UUID that is unique for this term

email

String, mandatory
Email address of the user

roles

String, mandatory
Role of this user. Possible values are listed on the right hand side

managerUserId

String, optional
The user id of the manager of this user

approvalLevel

String, optional
Any specific role this user has in your approval process, e.g. "Director"

approvalLimitAmountInCents

Number, optional
The maximum amount up to which this user can approve orders in cents. If this field is not set, it is deemed to be zero and their manager will have to approve all their orders

approvalLimitCurrency

String, mandatory when approvalLimitAmountInCents is defined
The currency for this order using the ISO-4217 standard.

tags

Array, optional
A set of user defined key:value pairs that can be used as default buyerTags or sellerTags for orders created by this user

ROLE_TRADER_ADMIN

Admin user

ROLE_TRADER_STANDARD

Standard user

Suggest Edits

Create users

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.yordex.com/v1/users
curl https://api.yordex.com/v1/users  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{
  "email":"name@company.com",
  "roles":["ROLE_TRADER_STANDARD"],
  "managerUserId":"manager-user-id",
  "approvalLevel":"Director",
  "approvalLimitCurrency":"USD",
  "approvalLimitAmountInCents":1000000,
  "tags": [
    "department":"Finance"
  ]
}'
A binary file was returned

You couldn't be authenticated

{
  "id":"user-id",
  "email":"name@company.com",
  "roles":["ROLE_TRADER_STANDARD"],
  "traderId": "your-trader-id",
  "managerUserId": "manager-user-id",
  "approvalLevel": "Director",
  "approvalLimitAmountInCents": 1000000,
  "approvalLimitCurrency": "USD",
  "tags": [
    "department":"Finance"
  ],
  "enabled": true,
  "emailConfirmed": false
}

Body Params

email
string
required
roles
array of strings
required
managerUserId
string
approvalLevel
string
approvalLimitCurrency
string
approvalLimitAmountInCents
int32
tags
array of objects
accountingCode

Headers

Authorization
string
 
Suggest Edits

Update users

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.yordex.com/v1/users/userId
curl https://api.yordex.com/v1/users/user-id  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X PUT  
-d '{
  "roles":["ROLE_TRADER_STANDARD"],
  "managerUserId":"manager-user-id",
  "approvalLevel":"Director",
  "approvalLimitCurrency":"USD",
  "approvalLimitAmountInCents":1000000,
  "tags": [
    "department":"Finance"
  ]
}'
A binary file was returned

You couldn't be authenticated

{
  "id":"user-id",
  "email":"name@company.com",
  "roles":["ROLE_TRADER_STANDARD"],
  "traderId": "your-trader-id",
  "managerUserId": "manager-user-id",
  "approvalLevel": "Director",
  "approvalLimitAmountInCents": 1000000,
  "approvalLimitCurrency": "USD",
  "tags": [
    "department":"Finance"
  ],
  "enabled": true,
  "emailConfirmed": false
}

Path Params

userId
string
required

Body Params

roles
array of strings
required
managerUserId
string
approvalLevel
string
approvalLimitCurrency
string
approvalLimitAmountInCents
int32
tags
array of objects
accountingCode

Headers

Authorization
string
 
 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/users/userId
curl https://api.yordex.com/v1/users/user-id  
-H "Authorization:your-api-key"  
-X GET  
A binary file was returned

You couldn't be authenticated

{
  "id":"user-id",
  "email":"name@company.com",
  "roles":["ROLE_TRADER_STANDARD"],
  "traderId": "your-trader-id",
  "managerUserId": "manager-user-id",
  "approvalLevel": "Director",
  "approvalLimitAmountInCents": 1000000,
  "approvalLimitCurrency": "USD",
  "tags": [
    "department":"Finance"
  ],
  "enabled": true,
  "emailConfirmed": false
}

Path Params

userId
string
required

Headers

Authorization
string
 
Suggest Edits

Get all users

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.yordex.com/v1/users
curl https://api.yordex.com/v1/users
-H "Authorization:your-api-key"  
-X GET  
A binary file was returned

You couldn't be authenticated

{
  "users": [
    {
      "id":"user-id-1",
      "email":"name1@company.com",
      "roles":["ROLE_TRADER_STANDARD"],
      "traderId": "your-trader-id",
      "managerUserId": "manager-user-id",
      "approvalLevel": "Director",
      "approvalLimitAmountInCents": 1000000,
      "approvalLimitCurrency": "USD",
      "tags": [
        "department":"Finance"
      ],
      "enabled": true,
      "emailConfirmed": true
    }, 
    {
      "id":"user-id-2",
      "email":"name2@company.com",
      "roles":["ROLE_TRADER_ADMIN"],
      "traderId": "your-trader-id",
      "managerUserId": "manager-user-id",
      "approvalLevel": "Standard",
      "approvalLimitAmountInCents": 10000,
      "approvalLimitCurrency": "USD",
      "tags": [
        "department":"Marketing"
      ],
      "enabled": true,
      "emailConfirmed": true
    }
  ]
}

Query Params

managerUserId
string
email
string
q
string

Headers

Authorization
string
 
Suggest Edits

Delete user

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.yordex.com/v1/users/userId
curl https://api.yordex.com/v1/users/user-id  
-H "Authorization:your-api-key"  
-X DELETE 
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

userId
string
required

Headers

Authorization
string